mirror of
https://github.com/facebook/docusaurus.git
synced 2025-07-24 12:07:58 +02:00
docs: document siteConfig.markdown + better mdx-loader retrocompat (#8419)
This commit is contained in:
parent
681e6d3ea4
commit
59fac0b1d1
3 changed files with 38 additions and 1 deletions
|
@ -394,6 +394,30 @@ module.exports = {
|
|||
};
|
||||
```
|
||||
|
||||
### `markdown` {#markdown}
|
||||
|
||||
The global Docusaurus Markdown config.
|
||||
|
||||
- Type: `MarkdownConfig`
|
||||
|
||||
```ts
|
||||
type MarkdownConfig = {
|
||||
mermaid: boolean;
|
||||
};
|
||||
```
|
||||
|
||||
Example:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
markdown: {
|
||||
mermaid: true,
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
- `mermaid`: when `true`, allows Docusaurus to render Markdown code blocks with `mermaid` language as Mermaid diagrams.
|
||||
|
||||
### `customFields` {#customFields}
|
||||
|
||||
Docusaurus guards `docusaurus.config.js` from unknown fields. To add a custom field, define it on `customFields`.
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue