Skip to content

Commit

Permalink
docs: fix frontMatter.mdx.format docs (#10631)
Browse files Browse the repository at this point in the history
  • Loading branch information
@slorber
slorber authored Oct 31, 2024
1 parent e700106 commit 5c1ce01
Show file tree
Hide file tree
Showing 14 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion website/docs/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion website/docs/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.0.1/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.0.1/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.1.1/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.1.1/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.2.1/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.2.1/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.3.2/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.3.2/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.4.0/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.4.0/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.5.2/guides/markdown-features/markdown-features-intro.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.

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

Expand Down
2 changes: 1 addition & 1 deletion ...rsioned_docs/version-3.5.2/guides/markdown-features/markdown-features-react.mdx
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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:

- The `format: md` front matter
- The `mdx.format: md` front matter
- 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).
Expand Down

0 comments on commit 5c1ce01

Please sign in to comment.