mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-29 22:47:52 +02:00
refactor(init): share common files between templates (#5315)
* Create shared folder & update init logic Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Restore needed links Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Prevent copying symlinks Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Reuse some FB files Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor tweak Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Minor refactors Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Fix bootstrap url Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Add path alias Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * Handle facebook template more gracefully Signed-off-by: Josh-Cena <sidachen2003@gmail.com> * minor refactor: extract getTypeScriptBaseTemplate Co-authored-by: slorber <lorber.sebastien@gmail.com>
This commit is contained in:
parent
58a8b0ea2c
commit
4c246493ef
98 changed files with 72 additions and 1431 deletions
|
@ -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:
|
||||
|
||||

|
||||
|
||||
## 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`
|
Loading…
Add table
Add a link
Reference in a new issue