docs(v2): minor tweaks (#4981)

This commit is contained in:
Alexey Pyltsyn 2021-06-16 12:04:40 +03:00 committed by GitHub
parent bfd33dc63a
commit d7e4e422a2
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
14 changed files with 25 additions and 21 deletions

View file

@ -5,7 +5,7 @@ description: Create a Markdown Document
slug: /create-doc
---
Create a markdown file, `greeting.md`, and place it under the `docs` directory.
Create a Markdown file, `greeting.md`, and place it under the `docs` directory.
```bash
website # root directory of your site
@ -76,4 +76,8 @@ The headers are well-spaced so that the hierarchy is clear.
- and you may nest them
- multiple times
<h3 id="custom-id">Custom id headers</h3>
With <code>{#custom-id}</code> syntax you can set your own header id.
</BrowserWindow>

View file

@ -5,7 +5,7 @@ description: Docusaurus Markdown features that are specific to the docs plugin
slug: /docs-markdown-features
---
Docs can use any [Markdown feature](../markdown-features/markdown-features-intro.mdx), and have a few additional Docs-specific markdown features.
Docs can use any [Markdown feature](../markdown-features/markdown-features-intro.mdx), and have a few additional docs-specific Markdown features.
## Markdown frontmatter {#markdown-frontmatter}

View file

@ -116,7 +116,7 @@ module.exports = {
## Using multiple sidebars {#using-multiple-sidebars}
You can create a sidebar for each **set of markdown files** that you want to **group together**.
You can create a sidebar for each **set of Markdown files** that you want to **group together**.
:::tip
@ -495,7 +495,7 @@ docs
To make it **easier to adopt**, Docusaurus supports **multiple number prefix patterns**.
By default, Docusaurus will **remove the number prefix** from the doc id, title, label and url paths.
By default, Docusaurus will **remove the number prefix** from the doc id, title, label and URL paths.
:::caution

View file

@ -180,7 +180,7 @@ As a good rule of thumb, try to keep the number of your versions below 10. **It
### Use absolute import within the docs {#use-absolute-import-within-the-docs}
Don't use relative paths import within the docs. Because when we cut a version the paths no longer work (the nesting level is different, among other reasons). You can utilize the `@site` alias provided by docusaurus, that points to the `website` directory. Example:
Don't use relative paths import within the docs. Because when we cut a version the paths no longer work (the nesting level is different, among other reasons). You can utilize the `@site` alias provided by Docusaurus, that points to the `website` directory. Example:
```diff
- import Foo from '../src/components/Foo';