-
-
Notifications
You must be signed in to change notification settings - Fork 5.7k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Versioned Documentation #617
Comments
I would also be interested in this. I don't know if it currently exists with docsify. |
Ha this seems to be a great challenge only yet solved by |
As long as docsify will render stuff on the fly there will be no guarantee that older documents will be rendered properly due to breaking changes. Nevertheless it's possible to achieve this, but not by fetching the content of older documents from a repository. I actually like the idea of mike in terms of immutability and it's good that this is an own tool, because your documentation tool should not rely on anything git related. Of course readthedocs is an exception because it's service, not a CLI which you run on your local machine. I mean the whole infrastructure is based on a repository. Anyhow for docsify we can define a configuration file which allows define a map (version -> zip) for older versions. The archive can be extracted in the browser on the fly which would require lot of refactor. Alternatively we extends docsify for a optional build step which is handling the extraction in order to avoid logic to render pages of a zip on the fly. |
Would it be possible to use docsify with git tags to fix that ticket? I don't like creating folders per version as it congest the repo and plus, it some sort of duplication since docs are already versionned by github itself |
This is something which would be really interesting. I wont go for any repo related op cause its quite hard to achieve and many docsify users uses different repo management sites to host their docs What I am proposing is CLICommand :
What it will do ?It will create a folder inside
it will create an main docsify libraryMaking support of Performance
I think we can consider this feature for cc @docsifyjs/core @trusktr @jamesgeorge007 |
Would there be an option to specify the tag or version as a variable inside the URLs that are used to fetch remote content or source files? This would be very helpful to fetch the related documentation and examples based of the version tag from a specific repository. |
There is an active proposal #1289 |
Closing in favor of #1289 |
Is there a way to create versioned documentation? I have been searching around and found this issue: #572 which mentions different versions. Also this ticket #341 asking for rendering from different branches.
I can't find anything in the Docsify docs talking about versioning.
Thanks!
The text was updated successfully, but these errors were encountered: