aboutsummaryrefslogtreecommitdiff
path: root/docs/tutorial-extras/manage-docs-versions.md
diff options
context:
space:
mode:
authorNikita Tchayka <nikitatchayka@gmail.com>2023-08-27 13:01:29 +0100
committerNikita Tchayka <nikitatchayka@gmail.com>2023-08-27 13:01:29 +0100
commit659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51 (patch)
treeeca686ecb16ff82a1fd1f731aa237841acdfb982 /docs/tutorial-extras/manage-docs-versions.md
downloadneohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.tar.gz
neohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.tar.bz2
neohaskell.github.io-659aeff39ded6bf6bd0dfc40ccc5ff07ffc10f51.zip
Update
Diffstat (limited to 'docs/tutorial-extras/manage-docs-versions.md')
-rw-r--r--docs/tutorial-extras/manage-docs-versions.md55
1 files changed, 55 insertions, 0 deletions
diff --git a/docs/tutorial-extras/manage-docs-versions.md b/docs/tutorial-extras/manage-docs-versions.md
new file mode 100644
index 0000000..e12c3f3
--- /dev/null
+++ b/docs/tutorial-extras/manage-docs-versions.md
@@ -0,0 +1,55 @@
+---
+sidebar_position: 1
+---
+
+# Manage Docs Versions
+
+Docusaurus can manage multiple versions of your docs.
+
+## Create a docs version
+
+Release a version 1.0 of your project:
+
+```bash
+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` at `http://localhost:3000/docs/` for the version 1.0 docs
+- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
+
+## Add a Version Dropdown
+
+To navigate seamlessly across versions, add a version dropdown.
+
+Modify the `docusaurus.config.js` file:
+
+```js title="docusaurus.config.js"
+module.exports = {
+ themeConfig: {
+ navbar: {
+ items: [
+ // highlight-start
+ {
+ type: 'docsVersionDropdown',
+ },
+ // highlight-end
+ ],
+ },
+ },
+};
+```
+
+The docs version dropdown appears in your navbar:
+
+![Docs Version Dropdown](./img/docsVersionDropdown.png)
+
+## Update an existing version
+
+It is possible to edit versioned docs in their respective folder:
+
+- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
+- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`