Manage Docs Versions
Docusaurus can manage multiple versions of your docs.
#
Create a docs versionRelease a version 1.0 of your project:
npm run docusaurus docs:version 1.0
The docs
folder is copied into versioned_docs/version-1.0
and versions.json
is created.
Your docs now have 2 versions:
1.0
athttp://localhost:3000/docs/
for the version 1.0 docscurrent
athttp://localhost:3000/docs/next/
for the upcoming, unreleased docs
#
Add a Version DropdownTo navigate seamlessly across versions, add a version dropdown.
Modify the docusaurus.config.js
file:
docusaurus.config.js
module.exports = { themeConfig: { navbar: { items: [ { type: "docsVersionDropdown", }, ], }, },};
The docs version dropdown appears in your navbar:
#
Update an existing versionIt is possible to edit versioned docs in their respective folder:
versioned_docs/version-1.0/hello.md
updateshttp://localhost:3000/docs/hello
docs/hello.md
updateshttp://localhost:3000/docs/next/hello