[V2] Versioning Suggestions
See original GitHub issueš„ Proposal
Hi! As I work on developing my Docusaurus site (https://squirrelly.js.org), Iāve noticed a few problems with the current versioning system.
- Pages arenāt versioned. This is a problem for me because on one page I host a live playground, and the syntax changes completely between the new and old libraries.
docusaurus.config.jsisnāt versioned. In my top bar, I link to different docs files. However, no matter what version Iām viewing, they always link to the latest docs (ex./docs/instead ofdocs/some-version/).- Thereās no way to get the current version in your React Components, so, for example, on the Docusaurus site, the link next to Docusaurus always reads
alpha.43, no matter what version youāre currently viewing.
With these problems in mind, Iād suggest having a public version variable. This could be provided to MDX files, similarly to withBaseUrl. It would also be nice if you could, in docusaurus.config.js, export a function that accepted a version string as the parameter.
Have you read the Contributing Guidelines on issues?
Yes
Issue Analytics
- State:
- Created 4 years ago
- Reactions:3
- Comments:26 (11 by maintainers)
Top Results From Across the Web
Semantic Versioning 2.0.0 | Semantic Versioning
In systems with many dependencies, releasing new package versions can quickly become a nightmare. If the dependency specifications are too tight, you are...
Read more >Best Practices When Versioning a Release | Cloudbees Blog
Five Tips for Implementing Semantic Versioning Ā· 1 - Communicate clearly to your users Ā· 2 - Have an open release schedule (that...
Read more >Best Practices When Versioning a Release - LinkedIn
1. Communicate clearly to your users Ā· 2. Have an open release schedule (that changes gradually) Ā· 3. Be consistent and predictable Ā·...
Read more >Software versioning - Wikipedia
Software versioning is the process of assigning either unique version names or unique version numbers to unique states of computer software.
Read more >API Versioning Do's and Don'ts. It's never too ... - Bits and Pieces
Versioning strategy. The whole idea of this article is that you need to have a way to organize the way you version your...
Read more >
Top Related Medium Post
No results found
Top Related StackOverflow Question
No results found
Troubleshoot Live Code
Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free
Top Related Reddit Thread
No results found
Top Related Hackernoon Post
No results found
Top Related Tweet
No results found
Top Related Dev.to Post
No results found
Top Related Hashnode Post
No results found

We will add the
useVersionhook, the more we need it to show the version of docs in navbar.Exactly, this: