docsifyjs / docsifyjs/docsify

Ability to render documentation versions from git branch or tag

未关闭
#341 11 条评论 30 个 reaction 已指派 0 人 在 GitHub 查看
enhancement
主要语言
JavaScript
星标
31.5k
派生
5.8k
平均合并
9 天 8 小时
30 天内合并 PR
2

描述

It would be awesome to have options to:
- render from only specified branches/tags
- specify url prefix for document version
- render some switcher (like for translations in _navbar.md)

----
something like this:
```js
window.$docsify = {
// ...
versions: {
'master': 'latest', // <-- branch 'master' will render by accessing url '/en/latest'
'1.5.1': '1.0', // <-- its just the tag '1.5.1' in git & no branch created (url '/en/1.0')
'2.0': '2.0' // <-- this is created branch (url '/en/2.0')
}
// ...
}
```

贡献指南

打开贡献指南

调研方向

未指定文件、测试或入口点。首先定位现有的配置和文档渲染入口点,然后跟踪文档 URL 的解析方式。完成标准是支持所提议的 branch/tag 选择、URL 前缀和版本切换器,同时不破坏当前的渲染。

由索引模型根据 Issue 内容生成。

评估

技术栈
javascript
领域
documentation
Issue 类型
功能
难度
5/5
预计耗时
一周以上
活跃度
停滞
描述清晰度
基本清楚
新手友好度
25/100

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。