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.5k
- 分支
- 5.8k
- 平均合併
- 7 天 18 小時
- 30 天內合併 PR
- 9
環境準備
- 提供 Dockerfile 或 Docker Compose 檔案
- 有 Pull Request 範本
- 閱讀貢獻指南
從這裡開始
- 先讀完整個 Issue，再讀專案的貢獻指南。
- 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
- Fork 儲存庫，在一個分支上完成修改。
- 送出 Pull Request，並在描述裡引用這個 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
維護者通常 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 於 77 天前認領，目前沒有進行中的 PR。 未關閉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
-
難度 1/5 1 小時以內 新手友好度 83/100
module-federation/core#5205 ·
維護者通常 1 天內回覆
-
affects:v0.5.2 area:frontend audit:ui-ux-2026-10 bug priority:P2
難度 2/5 1-3 小時 新手友好度 82/100
berntpopp/kidney-genetics-db#326 ·
維護者通常 1 天內回覆
-
task
難度 1/5 1 小時以內 新手友好度 83/100
TAMULib/fw-registry#550 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 79/100
-
NWCWalletService.subscribe: response is never published if the handler finishes after unsubscribe (regression in 8.1.0)可能已有人在做 @ajaysehwal 今天認領。 未關閉
難度 2/5 1-3 小時 新手友好度 83/100