docsifyjs / docsifyjs/docsify

Support specifying short-titles for the sidebar from content pages?

Ouverte
#1,821 3 commentaires 1 réaction 0 personnes assignées Voir sur GitHub
Langage dominant
JavaScript
Étoiles
31.5k
Forks
5.8k
Merge moyen
9 j 8 h
PR mergées (30 j)
2

Description

## Feature request

#### What problem does this feature solve?

This feature would allow long titles for the documentation headers, with short titles in the sidebar, when needed. Right now, this can be done by manually creating each and every entry for the sidebar, but this:

a) takes *a lot* of time,
b) is very prone to errors, and
c) forces you to write each and every sidebar entry yourself, even if short-titles are only required for a couple of entries.

#### What does the proposed API look like?

#### How should this be implemented in your opinion?

Right now, Docsify supports [Customise ID for headings](https://docsify.js.org/#/helpers?id=customise-id-for-headings). It would be great if it would also support something like:

```
## How would I write a "hello, world" example? :sidebar="hello world?"
```

![image](https://user-images.githubusercontent.com/19333579/174432003-2e234fb2-3527-441c-87e0-e0244240be4a.png)

#### Are you willing to work on this yourself?

Willing? yes, but realistically, I don't now how to do frontend development.

#### Relation to other issues?
This issue has of course some relation to [Proposal: auto generate sidebar](/docsifyjs/docsify/issues/1290) but as far as I can see the two are not the same, and I suspect the difficulties that would be part auto-generating the *entire* sidebar do not apply to only generating the in-page links(?)

Guide de contribution

Ouvrir le guide de contribution

Piste de recherche

Commencez par la documentation de Docsify sur « Customise ID for headings » et comparez la proposition avec l’issue #1290 concernant la génération automatique de la barre latérale. Suivez la façon dont le contenu des titres devient des entrées de la barre latérale ; le travail est considéré comme terminé lorsqu’un titre court inline tel que `:sidebar="hello world?"` est pris en charge tout en conservant le titre complet du titre.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
javascript
Domaine
documentation
Type d'issue
Fonctionnalité
Difficulté
4/5
Temps estimé
3-5 jours
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
42/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.