Proposal: display multiple versions of docs
维护者通常 8 天内回复
@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
- 平均合并
- 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 于 23 天前认领。 未关闭
难度 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 于 23 天前认领。 未关闭
难度 3/5 1-2 天 新手友好度 68/100
维护者通常 8 天内回复
-
In the Edge browser, the character `{docsify-updated}` is not replaced可能重新可做 @AmanUllah687 于 76 天前认领，目前没有进行中的 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
-
难度 2/5 1-3 小时 新手友好度 72/100
subhranshudash13-dotcom/Contribo#74 ·
维护者通常 1 天内回复
-
enhancement
难度 2/5 1-3 小时 新手友好度 62/100
维护者通常 1 天内回复
-
难度 1/5 1 小时以内 新手友好度 67/100
ThatGuySam/doesitarm#1114 ·
-
enhancement good first issue
难度 2/5 1-3 小时 新手友好度 85/100
laaielichter/Reverseport#44 ·
维护者通常 1 天内回复
-
failed for an unknown reason
难度 2/5 1-3 小时 新手友好度 65/100
OpenTermsArchive/contrib-declarations#4148 ·
维护者通常 1 天内回复