3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-06-19 19:22:28 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs(v2): use explicit heading IDs (#4460)

Browse source
This commit is contained in:
Alexey Pyltsyn 2021-03-19 13:00:41 +03:00 • committed by GitHub
parent 962c3748ea
commit 291a72fbae
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
162 changed files with 1435 additions and 1435 deletions
Download patch file Download diff file Expand all files Collapse all files

14
website/docs/guides/docs/docs-multi-instance.mdx
View file

@ -13,13 +13,13 @@ This feature is only useful for [versioned documentations](./versioning.md). It
:::
## Use-cases
## Use-cases {#use-cases}
Sometimes you want a Docusaurus site to host 2 distinct sets of documentation (or more).
These documentations may even have different versioning/release lifecycles.
### Mobile SDKs documentation
### Mobile SDKs documentation {#mobile-sdks-documentation}
If you build a cross-platform mobile SDK, you may have 2 documentations:
@ -36,7 +36,7 @@ If someone edits the iOS documentation, is it really useful to rebuild everythin
:::
### Versioned and unversioned doc
### Versioned and unversioned doc {#versioned-and-unversioned-doc}
Sometimes, you want some documents to be versioned, while other documents are more "global", and it feels useless to version them.
@ -45,7 +45,7 @@ We use this pattern on the Docusaurus website itself:
- The [/docs/\*](/docs) section is versioned
- The [/community/\*](/community/support) section is unversioned
## Setup
## Setup {#setup}
Let's consider we 2 documentations:
@ -138,7 +138,7 @@ We consider that the `product` instance is the most important one, and make it t
:::
## Versioned paths
## Versioned paths {#versioned-paths}
Each instance will store versioned docs in a distinct folder.
@ -162,7 +162,7 @@ The instance paths will be simpler, and retro-compatible with a single-instance
:::
## Tagging new versions
## Tagging new versions {#tagging-new-versions}
Each plugin instance will have its own cli command to tag a new version. They will be displayed if you run:
@ -182,7 +182,7 @@ To version the non-default/community docs plugin instance:
npm run docusaurus docs:version:community 1.0.0
```
## Docs navbar items
## Docs navbar items {#docs-navbar-items}
Each docs-related [theme navbar items](../../api/themes/theme-configuration.md#navbar) take an optional `docsPluginId` attribute.