Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Proposal: auto generate sidebar

Ouverte
  • Quelque chose ne va pas ?
#1,290 9 commentaires 17 réactions 1 personne assignée Voir sur GitHub

Les mainteneurs répondent en général sous 8 jours

@sy-records y travaille déjà.

Depuis le 28/7/2025.

Évaluation

Cette issue n'a pas encore été évaluée.

Description

enhancement pinned

Auto-generate sidebar

Summary

Auto-generate and update the sidebar i.e _sidebar.md by looking into the folders/files

Motivation

If you have a big project or a project having many markdown files. It is kind of extra work look for each file and writes the path and the file name and the text to display it.
Maximum projects I have seen take each .md file as a single page and .md files under a folder inside the docs directory is a sub-page. So if we go with usual lookups through each file/folder. This is quite easy to achieve.

Detailed Design

No changes are required in the core. Only needs changes in cli. New command probably

If we have directories like this

|- <root>
       |- README.md
       |- index.html
       |- _sidebar.md
       |- a.md
       |- guide
            |- guide-a.md
       |- b.md

The sidebar command should generate the following

- [a](./a.md)
- guide
  - [a](./guide/guide-a.md)
- [b](./b.md)

We need to traverse through the directory and create an object or tree and then just print the tree as a list in the markdown.

Documentation

Update the docs in the main docs site as a separate page and create docs for the command in the cli and do a remote rendering of the page in the main docs

Drawbacks

Few

  • It won't know whether markdown file should be in the heading or in subheading if it goes out of our prediction.
  • cant do the operation for the .html files.

Backwards Compatibility Analysis

Not required as no changes in the core is being done.

Alternatives

Do the manual entry in the _sidebar.md

Open Questions

  • Should we wait for or put this in v5 ?
  • Any volunteers for taking this ?

Help Needed

None.

Frequently Asked Questions

None

Related Discussions

Couldnt find any.

Langage dominant
JavaScript
Étoiles
31.5k
Forks
5.8k
Merge moyen
7 j 18 h
PR mergées (30 j)
9

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de docsifyjs/docsify

Toutes les issues de docsifyjs/docsify

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

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