3pp-mirror/docusaurus
1
0
Fork 0
mirror of https://github.com/facebook/docusaurus.git synced 2025-05-12 08:37:25 +02:00
Code Issues Projects Releases Packages Wiki Activity

docs: normalize capitalization (#7619)

Browse source
This commit is contained in:
Joshua Chen 2022-06-15 13:04:33 +08:00 • committed by GitHub
parent aeb6c971c0
commit e12a2efaeb
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
44 changed files with 99 additions and 99 deletions
Download patch file Download diff file Expand all files Collapse all files

24
website/docs/guides/markdown-features/markdown-features-admonitions.mdx
View file

@ -18,31 +18,31 @@ Example:
```md
:::note
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::tip
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::info
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::caution
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::danger
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
```
@ -52,31 +52,31 @@ Some **content** with _markdown_ `syntax`. Check [this `api`](#).
:::note
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::tip
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::info
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::caution
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
:::danger
Some **content** with _markdown_ `syntax`. Check [this `api`](#).
Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
:::
@ -112,7 +112,7 @@ You may also specify an optional title
```md
:::note Your Title
Some **content** with _markdown_ `syntax`.
Some **content** with _Markdown_ `syntax`.
:::
```
@ -122,7 +122,7 @@ Some **content** with _markdown_ `syntax`.
:::note Your Title
Some **content** with _markdown_ `syntax`.
Some **content** with _Markdown_ `syntax`.
:::

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

@ -110,7 +110,7 @@ or
</BrowserWindow>
:::info markdown links are always file paths
:::info Markdown links are always file paths
If you use the Markdown image or link syntax, all asset paths will be resolved as file paths by Docusaurus and automatically converted to `require()` calls. You don't need to use `require()` in Markdown unless you use the JSX syntax, which you do have to handle yourself.

4
website/docs/guides/markdown-features/markdown-features-code-blocks.mdx
View file

@ -455,7 +455,7 @@ To use the plugin, create a code block with `live` attached to the language meta
function Clock(props) {
const [date, setDate] = useState(new Date());
useEffect(() => {
var timerID = setInterval(() => tick(), 1000);
const timerID = setInterval(() => tick(), 1000);
return function cleanup() {
clearInterval(timerID);
@ -485,7 +485,7 @@ The code block will be rendered as an interactive editor. Changes to the code wi
function Clock(props) {
const [date, setDate] = useState(new Date());
useEffect(() => {
var timerID = setInterval(() => tick(), 1000);
const timerID = setInterval(() => tick(), 1000);
return function cleanup() {
clearInterval(timerID);

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

@ -132,7 +132,7 @@ module.exports = {
## Self-hosting KaTeX assets {#self-hosting-katex-assets}
Loading stylesheets, fonts, and javascript libraries from CDN sources is a good practice for popular libraries and assets, since it reduces the amount of assets you have to host. In case you prefer to self-host the `katex.min.css` (along with required KaTeX fonts), you can download the latest version from [KaTeX GitHub releases](https://github.com/KaTeX/KaTeX/releases), extract and copy `katex.min.css` and `fonts` directory (only `.woff2` font types should be enough) to your site's `static` directory, and in `docusaurus.config.js`, replace the stylesheet's `href` from the CDN url to your local path (say, `/katex/katex.min.css`).
Loading stylesheets, fonts, and JavaScript libraries from CDN sources is a good practice for popular libraries and assets, since it reduces the amount of assets you have to host. In case you prefer to self-host the `katex.min.css` (along with required KaTeX fonts), you can download the latest version from [KaTeX GitHub releases](https://github.com/KaTeX/KaTeX/releases), extract and copy `katex.min.css` and `fonts` directory (only `.woff2` font types should be enough) to your site's `static` directory, and in `docusaurus.config.js`, replace the stylesheet's `href` from the CDN URL to your local path (say, `/katex/katex.min.css`).
```js title="docusaurus.config.js"
module.exports = {

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

@ -471,7 +471,7 @@ This feature is experimental and might be subject to breaking API changes in the
You can use Markdown files as components and import them elsewhere, either in Markdown files or in React pages.
By convention, using the **`_` filename prefix** will not create any doc page and means the markdown file is a **"partial"**, to be imported by other files.
By convention, using the **`_` filename prefix** will not create any doc page and means the Markdown file is a **"partial"**, to be imported by other files.
```md title="_markdown-partial-example.mdx"
<span>Hello {props.name}</span>

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

@ -49,7 +49,7 @@ A special Markdown syntax lets you set an **explicit heading id**:
:::tip
Use the **[write-heading-ids](../../cli.md#docusaurus-write-heading-ids-sitedir)** CLI command to add explicit ids to all your Markdown documents.
Use the **[write-heading-ids](../../cli.md#docusaurus-write-heading-ids-sitedir)** CLI command to add explicit IDs to all your Markdown documents.
:::
@ -61,7 +61,7 @@ Generated heading IDs will be guaranteed to be unique on each page, but if you u
## Inline table of contents {#inline-table-of-contents}
Each Markdown document displays a table of contents on the top-right corner. But it is also possible to display an inline table of contents directly inside a markdown document, thanks to MDX.
Each Markdown document displays a table of contents on the top-right corner. But it is also possible to display an inline table of contents directly inside a Markdown document, thanks to MDX.
The `toc` variable is available in any MDX document and contains all the headings of an MDX document. By default, only `h2` and `h3` headings are displayed in the TOC. You can change which heading levels are visible by setting `minHeadingLevel` or `maxHeadingLevel` for individual `TOCInline` components.
@ -121,7 +121,7 @@ The table-of-contents is generated by parsing the Markdown source with a [Remark
Markdown headings within hideable areas will still show up in the TOC. For example, headings within [`Tabs`](./markdown-features-tabs.mdx) and [`details`](./markdown-features-intro.mdx#details) will not be excluded.
Non-markdown headings will not show up in the TOC. This can be used to your advantage to tackle the aforementioned issue.
Non-Markdown headings will not show up in the TOC. This can be used to your advantage to tackle the aforementioned issue.
```md
<details>