3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-31 09:57:03 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: normalize capitalization (#7613)

Browse source
This commit is contained in:
Joshua Chen 2022-06-14 14:01:06 +08:00 • committed by GitHub
parent 56e7c3102e
commit aeb6c971c0
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
22 changed files with 43 additions and 43 deletions
Download patch file Download diff file Expand all files Collapse all files

6
website/docs/guides/docs/docs-create-doc.mdx
View file

@ -45,9 +45,9 @@ The headers are well-spaced so that the hierarchy is clear.
- and you may nest them
- multiple times
## Custom id headers {#custom-id}
## Custom ID headers {#custom-id}
With `{#custom-id}` syntax you can set your own header id.
With `{#custom-id}` syntax you can set your own header ID.
```
:::note
@ -92,7 +92,7 @@ How the Markdown files are arranged under the `docs` folder can have multiple im
Every document has a unique `id`. By default, a document `id` is the name of the document (without the extension) relative to the root docs directory.
For example, `greeting.md` id is `greeting` and `guide/hello.md` id is `guide/hello`.
For example, the ID of `greeting.md` is `greeting`, and the ID of `guide/hello.md` is `guide/hello`.
```bash
website # Root directory of your site

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

@ -135,7 +135,7 @@ Don't forget to assign a unique `id` attribute to plugin instances.
:::note
We consider that the `product` instance is the most important one, and make it the "default" instance by not assigning any id.
We consider that the `product` instance is the most important one, and make it the "default" instance by not assigning any ID.
:::
@ -165,7 +165,7 @@ The instance paths will be simpler, and retro-compatible with a single-instance
## 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:
Each plugin instance will have its own CLI command to tag a new version. They will be displayed if you run:
```bash npm2yarn
npm run docusaurus -- --help

2
website/docs/guides/docs/sidebar/index.md
View file

@ -198,7 +198,7 @@ A real-world example from the Docusaurus site:
```mdx-code-block
import CodeBlock from '@theme/CodeBlock';
<CodeBlock className="language-js" title="sidebars.js">
<CodeBlock language="js" title="sidebars.js">
{require('!!raw-loader!@site/sidebars.js')
.default
.split('\n')

2
website/docs/guides/markdown-features/markdown-features-toc.mdx
View file

@ -34,7 +34,7 @@ Each heading has an ID that can be automatically generated or explicitly specifi
<Link to="#heading-id">link</Link>
```
By default, Docusaurus will generate heading IDs for you, based on the heading text. For example, `### Hello World` will have id `hello-world`.
By default, Docusaurus will generate heading IDs for you, based on the heading text. For example, `### Hello World` will have ID `hello-world`.
Generated IDs have **some limitations**: