docs: fix frontMatter.mdx.format docs (#10631)

This commit is contained in:
Sébastien Lorber 2024-10-31 11:23:59 +01:00 committed by GitHub
parent e7001060da
commit 5c1ce0137c
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
14 changed files with 14 additions and 14 deletions

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -242,7 +242,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).

View file

@ -41,7 +41,7 @@ The MDX compiler supports [2 formats](https://mdxjs.com/packages/mdx/#optionsfor
By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons. By default, **Docusaurus v3 uses the MDX format for all files** (including `.md` files) for historical reasons.
It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `format: md` front matter. It is possible to **opt-in for CommonMark** using the [`siteConfig.markdown.format`](../../api/docusaurus.config.js.mdx#markdown) setting or the `mdx.format: md` front matter.
:::tip how to use CommonMark :::tip how to use CommonMark

View file

@ -248,7 +248,7 @@ Some valid CommonMark features won't work with MDX ([more info](https://mdxjs.co
Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options: Docusaurus v3 makes it possible to opt-in for a less strict, standard [CommonMark](https://commonmark.org/) support with the following options:
- The `format: md` front matter - The `mdx.format: md` front matter
- The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration - The `.md` file extension combined with the `siteConfig.markdown.format: "detect"` configuration
This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092). This feature is **experimental** and currently has a few [limitations](https://github.com/facebook/docusaurus/issues/9092).