Proposal: display multiple versions of docs
維護者通常 2 天內回覆
@anikethsaha 已經在處理了。
開始於 2020年7月27日。
評估
這個 Issue 還沒有評估資料。
描述
versioning
Summary
Support for creating docs for different versions.
Motivation
Versioning support in a documentation generator is quite helping as it helps in supporting separating the docs for different versions. Helps is covering breaking changes. Improves readability.
There are other documentation generators that support this like docusaurus, gitbook etc.
Detailed Design
This will mainly require to make changes in the docsify-cli repo. I don't think we need any changes in the core.
We have great support for having navbar We will make use of that.
- Configuration
...
$docsify = {
version : {
// none I guess
}
}
...
We can either make it to the navbar.
- cli command
docsify version <version> <path? = '.'>
This will do the following work in sequence
- it will create a version with name
<version>in<path> - check for the navbar markdown content i.e
_navbar.md - if present, good to go. If not present, ask whether the
CLIcan create a new one or not. If theCLIis answered withno. Stop the operation - Update the
_navbar.mdby pretending the content with creating a new listversions. First, it will check whetherversionsare present as list heading or not. and inside that, append the list with the<version>. Use the AST for the markdown content in order to prepend, append, and check for theversionlist heading. (probably useremark) - it will copy-paste every files/folder present in the current directory from where this command is being run i.e
process.cwd()
to that folder i.e<path>/<version> - Done
Documentation
Create a versioning page in main docs. Create CLI command docs in the docsify-cli and either embed or do the remote rendering in the main docs in order to always show the latest docs
Drawbacks
Few cons or drawbacks
- it mandates the use of
_navbar.md - cant be customizable.
<please comment if you find any>
Backwards Compatibility Analysis
Not required. As it will need changes in the cli not in the core.
Alternatives
Manually copy-pasting the files/folder and changing the _navbar.md
Open Questions
- do we want this on the sidebar? I tried but it was not looking good.
Help Needed
- Please provide some ( edge ) cases where this might break.
- Provide some suggestions to refine the proposal.
- At last, anyone wants to implement/take this ?
Frequently Asked Questions
N/A
Related Discussions
Forgot the repo + issue. But I did notice few issues and requests for this.
- 主要語言
- JavaScript
- 星號
- 31.5k
- 分支
- 5.8k
- 平均合併
- 2 天 14 小時
- 30 天內合併 PR
- 5
環境準備
- 提供 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 於 22 天前認領。 未關閉
難度 2/5 1-3 小時 新手友好度 88/100
維護者通常 2 天內回覆
-
bug Triage
難度 3/5 1-2 天 新手友好度 66/100
維護者通常 2 天內回覆
-
Cached AJAX responses lose status metadata exposed through vm.route.response可能已有人在做 @xu91102 於 22 天前認領。 未關閉
難度 3/5 1-2 天 新手友好度 68/100
維護者通常 2 天內回覆
-
In the Edge browser, the character `{docsify-updated}` is not replaced可能重新可做 @AmanUllah687 於 75 天前認領，目前沒有進行中的 PR。 未關閉wait for information
難度 4/5 3-5 天 新手友好度 35/100
docsifyjs/docsify#2681 · 11 則留言 ·
維護者通常 2 天內回覆
-
feature request Triage
難度 4/5 3-5 天 新手友好度 38/100
docsifyjs/docsify#2643 · 5 則留言 ·
維護者通常 2 天內回覆
查看 docsifyjs/docsify 的全部 Issue
相似的 Issue
-
bug
難度 2/5 1-3 小時 新手友好度 83/100
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 70/100
maproulette/maproulette-frontend#2944 ·
維護者通常 1 天內回覆
-
難度 2/5 1-3 小時 新手友好度 68/100
NanmiCoder/dsh-agent-teams#255 ·
維護者通常 1 天內回覆
-
bug
難度 2/5 1-3 小時 新手友好度 88/100
jaegertracing/jaeger-ui#4618 ·
維護者通常 1 天內回覆
-
area:plugins enhancement platform:vscode
難度 2/5 1-3 小時 新手友好度 88/100
anthropics/claude-code#103166 ·
維護者通常 1 天內回覆