Proposal: auto generate sidebar
メンテナーはふだん 8 日以内に返信
@sy-records がすでに取り組んでいます。
2025年7月28日 から。
評価
この issue はまだ評価されていません。
説明
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
.htmlfiles.
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.
- 主要言語
- JavaScript
- スター
- 31.6k
- フォーク
- 5.8k
- 平均マージ
- 7日 18時間
- マージ済み PR（30日）
- 9
環境構築
- Dockerfile または Docker Compose ファイルあり
- プルリクエストのテンプレートあり
- コントリビューションガイドを読む
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
docsifyjs/docsify のほかの issue
-
Query parameter values are truncated at a second equals sign対応中かも @xu91102 が 24 日前に担当しました。 オープン
難易度 2/5 1〜3時間 初心者へのやさしさ 88/100
メンテナーはふだん 8 日以内に返信
-
bug Triage
難易度 3/5 1〜2日 初心者へのやさしさ 66/100
docsifyjs/docsify#2839 · コメント 1 件 ·
メンテナーはふだん 8 日以内に返信
-
Cached AJAX responses lose status metadata exposed through vm.route.response対応中かも @xu91102 が 24 日前に担当しました。 オープン
難易度 3/5 1〜2日 初心者へのやさしさ 68/100
メンテナーはふだん 8 日以内に返信
-
In the Edge browser, the character `{docsify-updated}` is not replaced再び着手できるかも @AmanUllah687 が 78 日前に担当しましたが、オープン中のプルリクエストはありません。 オープンwait for information
難易度 4/5 3〜5日 初心者へのやさしさ 35/100
docsifyjs/docsify#2681 · コメント 11 件 ·
メンテナーはふだん 8 日以内に返信
-
feature request Triage
難易度 4/5 3〜5日 初心者へのやさしさ 38/100
docsifyjs/docsify#2643 · コメント 5 件 ·
メンテナーはふだん 8 日以内に返信
docsifyjs/docsify の issue をすべて見る
似ている issue
-
release-followup
難易度 2/5 1〜3時間 初心者へのやさしさ 82/100
メンテナーはふだん 1 日以内に返信
-
bug
難易度 2/5 1〜3時間 初心者へのやさしさ 84/100
メンテナーはふだん 1 日以内に返信
-
area: right sidebar
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
zulip/zulip#40449 · コメント 3 件 ·
メンテナーはふだん 2 日以内に返信
-
難易度 2/5 1〜3時間 初心者へのやさしさ 68/100
メンテナーはふだん 1 日以内に返信
-
cleanup
難易度 2/5 1〜3時間 初心者へのやさしさ 65/100
uclaacm/membership-portal-ui#409 ·
メンテナーはふだん 1 日以内に返信