docsifyjs / docsifyjs/docsify

Ability to render documentation versions from git branch or tag

Open
#341 11 comments 30 reactions 0 assignees View on GitHub
enhancement
Dominant language
JavaScript
Stars
31.5k
Forks
5.8k
Avg merge
9d 8h
Merged PRs (30d)
2

Description

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')
}
// ...
}
```

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.