diff --git a/website/_dogfooding/_blog tests/2021-08-21-blog-post-toc-tests.mdx b/website/_dogfooding/_blog tests/2021-08-21-blog-post-toc-tests.mdx
index 105d193ae6..fe66256a74 100644
--- a/website/_dogfooding/_blog tests/2021-08-21-blog-post-toc-tests.mdx
+++ b/website/_dogfooding/_blog tests/2021-08-21-blog-post-toc-tests.mdx
@@ -7,7 +7,7 @@ toc_max_heading_level: 4
tags: [paginated-tag]
---
-
+{/* truncate */}
import Content, {
toc as ContentToc,
diff --git a/website/_dogfooding/_blog tests/2021-10-07-blog-post-mdx-feed-tests.mdx b/website/_dogfooding/_blog tests/2021-10-07-blog-post-mdx-feed-tests.mdx
index a171eefe3f..7f501c7e4b 100644
--- a/website/_dogfooding/_blog tests/2021-10-07-blog-post-mdx-feed-tests.mdx
+++ b/website/_dogfooding/_blog tests/2021-10-07-blog-post-mdx-feed-tests.mdx
@@ -16,7 +16,7 @@ hide_reading_time: true
Some MDX tests, mostly to test how the RSS feed render those
-
+{/* truncate */}
## Imports
diff --git a/website/_dogfooding/_blog tests/2021-10-08-blog-post-mdx-require-feed-tests.mdx b/website/_dogfooding/_blog tests/2021-10-08-blog-post-mdx-require-feed-tests.mdx
index 1485ef0817..4c572b44fa 100644
--- a/website/_dogfooding/_blog tests/2021-10-08-blog-post-mdx-require-feed-tests.mdx
+++ b/website/_dogfooding/_blog tests/2021-10-08-blog-post-mdx-require-feed-tests.mdx
@@ -15,7 +15,7 @@ tags:
Some MDX tests, mostly to test how the RSS feed render those
-
+{/* truncate */}
Test MDX with require calls
diff --git a/website/_dogfooding/_blog tests/demo/2020-08-03-second-blog-intro.mdx b/website/_dogfooding/_blog tests/demo/2020-08-03-second-blog-intro.mdx
index c21273c78a..890a2c9a54 100644
--- a/website/_dogfooding/_blog tests/demo/2020-08-03-second-blog-intro.mdx
+++ b/website/_dogfooding/_blog tests/demo/2020-08-03-second-blog-intro.mdx
@@ -6,7 +6,7 @@ tags: [paginated-tag, blog, docusaurus]
Did you know you can use multiple instances of the same plugin?
-
+{/* truncate */}
:::tip
diff --git a/website/_dogfooding/_pages tests/code-block-tests.mdx b/website/_dogfooding/_pages tests/code-block-tests.mdx
index 2c955e110c..a73042cbe4 100644
--- a/website/_dogfooding/_pages tests/code-block-tests.mdx
+++ b/website/_dogfooding/_pages tests/code-block-tests.mdx
@@ -27,7 +27,7 @@ Multi-line text inside `pre` will turn into one-liner, but it's okay (https://gi
1 2 3
-
+{/* prettier-ignore */}
1
2
diff --git a/website/_dogfooding/_pages tests/markdownPageTests.mdx b/website/_dogfooding/_pages tests/markdownPageTests.mdx
index 35f7c2a4ff..e24e3b397b 100644
--- a/website/_dogfooding/_pages tests/markdownPageTests.mdx
+++ b/website/_dogfooding/_pages tests/markdownPageTests.mdx
@@ -51,20 +51,12 @@ import TabItem from '@theme/TabItem';
MDX comments can be used with
```mdx
-
+{/* My comment */}
```
See, nothing is displayed:
-
+{/* My comment */}
## Import code block from source code file
diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx
index e9c7c6e99d..9b4ff87628 100644
--- a/website/docs/api/docusaurus.config.js.mdx
+++ b/website/docs/api/docusaurus.config.js.mdx
@@ -123,7 +123,7 @@ The i18n configuration object to [localize your site](../i18n/i18n-introduction.
Example:
-
+{/* cSpell:ignore فارسی */}
```js title="docusaurus.config.js"
module.exports = {
diff --git a/website/docs/blog.mdx b/website/docs/blog.mdx
index 02f870da6f..9276a52c30 100644
--- a/website/docs/blog.mdx
+++ b/website/docs/blog.mdx
@@ -63,7 +63,7 @@ hide_table_of_contents: false
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
-
+
This is my first post on Docusaurus 2.
@@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front-
The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed.
-Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example:
+Use the `{/*truncate*/}` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `{/*truncate*/}` will be part of the summary. For example:
```md
---
@@ -87,7 +87,7 @@ All these will be part of the blog post summary.
Even this.
-
+
But anything from here on down will not be.
diff --git a/website/docs/guides/markdown-features/markdown-features-admonitions.mdx b/website/docs/guides/markdown-features/markdown-features-admonitions.mdx
index 231851f7db..24c183eef9 100644
--- a/website/docs/guides/markdown-features/markdown-features-admonitions.mdx
+++ b/website/docs/guides/markdown-features/markdown-features-admonitions.mdx
@@ -87,7 +87,7 @@ Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.
-
+{/* prettier-ignore */}
```md
:::note
diff --git a/website/docs/guides/markdown-features/markdown-features-react.mdx b/website/docs/guides/markdown-features/markdown-features-react.mdx
index 0327c1e160..4baabbb43c 100644
--- a/website/docs/guides/markdown-features/markdown-features-react.mdx
+++ b/website/docs/guides/markdown-features/markdown-features-react.mdx
@@ -76,7 +76,7 @@ I can write **Markdown** alongside my _JSX_!
Since all doc files are parsed using MDX, anything that looks like HTML is actually JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects.
-
+{/* prettier-ignore */}
```jsx
/* Instead of this: */
Foo
@@ -94,7 +94,7 @@ In addition, MDX is not [100% compatible with CommonMark](https://github.com/fac
You can also import your own components defined in other files or third-party components installed via npm.
-
+{/* prettier-ignore */}
```md
import TOCInline from '@theme/TOCInline';
@@ -339,7 +339,7 @@ Use JSX within JSX tag, or move the Markdown to the outer layer:
```
-
+{/* prettier-ignore */}
```jsx
**Bold still doesn't work**
@@ -365,7 +365,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -395,7 +395,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -425,7 +425,7 @@ Don't indent:
```
-
+{/* prettier-ignore */}
```jsx
@@ -461,14 +461,13 @@ npm install --save raw-loader
Now you can import code snippets from another file as it is:
-
+{/* prettier-ignore */}
```jsx title="myMarkdownFile.mdx"
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';
{MyComponentSource}
```
-
```mdx-code-block
import CodeBlock from '@theme/CodeBlock';
@@ -507,13 +506,12 @@ By convention, using the **`_` filename prefix** will not create any doc page an
This is text some content from `_markdown-partial-example.mdx`.
```
-
+{/* prettier-ignore */}
```jsx title="someOtherDoc.mdx"
import PartialExample from './_markdown-partial-example.mdx';
```
-
```mdx-code-block
import PartialExample from './_markdown-partial-example.mdx';
diff --git a/website/docs/guides/markdown-features/markdown-features-tabs.mdx b/website/docs/guides/markdown-features/markdown-features-tabs.mdx
index 948c61ef67..4f9973d557 100644
--- a/website/docs/guides/markdown-features/markdown-features-tabs.mdx
+++ b/website/docs/guides/markdown-features/markdown-features-tabs.mdx
@@ -15,7 +15,7 @@ import styles from './markdown-features-tabs-styles.module.css';
Docusaurus provides the `
` component that you can use in Markdown thanks to [MDX](./markdown-features-react.mdx):
-
+{/* prettier-ignore */}
```jsx
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -32,7 +32,6 @@ import TabItem from '@theme/TabItem';
```
-
```mdx-code-block
@@ -250,7 +249,7 @@ You might want to customize the appearance of a certain set of tabs. You can pas
You can also customize each tab heading independently by using the `attributes` field. The extra props can be passed to the headings either through the `values` prop in `Tabs`, or props of each `TabItem`—in the same way as you declare `label`.
-
+{/* prettier-ignore */}
```jsx title="some-doc.mdx"
import styles from './styles.module.css';
@@ -266,7 +265,6 @@ import styles from './styles.module.css';
```
-
```css title="styles.module.css"
.red {
diff --git a/website/docs/guides/markdown-features/markdown-features-toc.mdx b/website/docs/guides/markdown-features/markdown-features-toc.mdx
index 4b2857c4f7..b4e81fde83 100644
--- a/website/docs/guides/markdown-features/markdown-features-toc.mdx
+++ b/website/docs/guides/markdown-features/markdown-features-toc.mdx
@@ -102,7 +102,7 @@ It is also possible to display an inline table of contents directly inside a Mar
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.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
@@ -129,7 +129,7 @@ declare const toc: {
Note that the `toc` global is a flat array, so you can easily cut out unwanted nodes or insert extra nodes, and create a new TOC tree.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
diff --git a/website/docs/introduction.mdx b/website/docs/introduction.mdx
index 46b616c7d5..85d26b6a76 100644
--- a/website/docs/introduction.mdx
+++ b/website/docs/introduction.mdx
@@ -129,18 +129,6 @@ Docusaurus 2 is born to be compassionately accessible to all your users, and lig
We believe that, as developers, knowing how a library works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various components of Docusaurus with the hope that users reading it will gain a deeper understanding of the tool and be even more proficient in using it.
-
-
## Comparison with other tools {#comparison-with-other-tools}
Across all static site generators, Docusaurus has a unique focus on documentation sites and has many out-of-the-box features.
diff --git a/website/docs/search.mdx b/website/docs/search.mdx
index 32fdcd7f68..78f785bca0 100644
--- a/website/docs/search.mdx
+++ b/website/docs/search.mdx
@@ -247,7 +247,7 @@ Still, you can reuse the [Infima CSS variables](styling-layout.mdx#styling-your-
### Customizing the Algolia search behavior {#customizing-the-algolia-search-behavior}
-
+{/* TODO: update options link once the documentation is available on the DocSearch website */}
Algolia DocSearch supports a [list of options](https://autocomplete-experimental.netlify.app/docs/DocSearchModal#reference) that you can pass to the `algolia` field in the `docusaurus.config.js` file.
diff --git a/website/versioned_docs/version-2.0.1/api/docusaurus.config.js.mdx b/website/versioned_docs/version-2.0.1/api/docusaurus.config.js.mdx
index cdce44e0dd..ae1803e512 100644
--- a/website/versioned_docs/version-2.0.1/api/docusaurus.config.js.mdx
+++ b/website/versioned_docs/version-2.0.1/api/docusaurus.config.js.mdx
@@ -123,7 +123,7 @@ The i18n configuration object to [localize your site](../i18n/i18n-introduction.
Example:
-
+{/* cSpell:ignore فارسی */}
```js title="docusaurus.config.js"
module.exports = {
diff --git a/website/versioned_docs/version-2.0.1/blog.mdx b/website/versioned_docs/version-2.0.1/blog.mdx
index a2262e2f11..a59ff92e8c 100644
--- a/website/versioned_docs/version-2.0.1/blog.mdx
+++ b/website/versioned_docs/version-2.0.1/blog.mdx
@@ -63,7 +63,7 @@ hide_table_of_contents: false
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
-
+
This is my first post on Docusaurus 2.
@@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front-
The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed.
-Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example:
+Use the `{/*truncate*/}` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `{/*truncate*/}` will be part of the summary. For example:
```md
---
@@ -87,7 +87,7 @@ All these will be part of the blog post summary.
Even this.
-
+
But anything from here on down will not be.
diff --git a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx
index f4c00f7c3f..0ea3e6b907 100644
--- a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx
+++ b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-admonitions.mdx
@@ -87,7 +87,7 @@ Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.
-
+{/* prettier-ignore */}
```md
:::note
diff --git a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-react.mdx
index a8d76f1067..ea6fbd9e48 100644
--- a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-react.mdx
+++ b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-react.mdx
@@ -76,7 +76,7 @@ I can write **Markdown** alongside my _JSX_!
Since all doc files are parsed using MDX, anything that looks like HTML is actually JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects.
-
+{/* prettier-ignore */}
```jsx
/* Instead of this: */
Foo
@@ -94,7 +94,7 @@ In addition, MDX is not [100% compatible with CommonMark](https://github.com/fac
You can also import your own components defined in other files or third-party components installed via npm.
-
+{/* prettier-ignore */}
```md
import TOCInline from '@theme/TOCInline';
@@ -339,7 +339,7 @@ Use JSX within JSX tag, or move the Markdown to the outer layer:
```
-
+{/* prettier-ignore */}
```jsx
**Bold still doesn't work**
@@ -365,7 +365,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -395,7 +395,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -425,7 +425,7 @@ Don't indent:
```
-
+{/* prettier-ignore */}
```jsx
@@ -461,14 +461,13 @@ npm install --save raw-loader
Now you can import code snippets from another file as it is:
-
+{/* prettier-ignore */}
```jsx title="myMarkdownFile.mdx"
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';
{MyComponentSource}
```
-
```mdx-code-block
import CodeBlock from '@theme/CodeBlock';
@@ -507,13 +506,12 @@ By convention, using the **`_` filename prefix** will not create any doc page an
This is text some content from `_markdown-partial-example.mdx`.
```
-
+{/* prettier-ignore */}
```jsx title="someOtherDoc.mdx"
import PartialExample from './_markdown-partial-example.mdx';
```
-
```mdx-code-block
import PartialExample from './_markdown-partial-example.mdx';
diff --git a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-tabs.mdx b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-tabs.mdx
index 897f54a8a7..987f1067a3 100644
--- a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-tabs.mdx
+++ b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-tabs.mdx
@@ -15,7 +15,7 @@ import styles from './markdown-features-tabs-styles.module.css';
Docusaurus provides the `
` component that you can use in Markdown thanks to [MDX](./markdown-features-react.mdx):
-
+{/* prettier-ignore */}
```jsx
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -32,7 +32,6 @@ import TabItem from '@theme/TabItem';
```
-
```mdx-code-block
@@ -250,7 +249,7 @@ You might want to customize the appearance of a certain set of tabs. You can pas
You can also customize each tab heading independently by using the `attributes` field. The extra props can be passed to the headings either through the `values` prop in `Tabs`, or props of each `TabItem`—in the same way as you declare `label`.
-
+{/* prettier-ignore */}
```jsx title="some-doc.mdx"
import styles from './styles.module.css';
@@ -266,7 +265,6 @@ import styles from './styles.module.css';
```
-
```css title="styles.module.css"
.red {
diff --git a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-toc.mdx b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-toc.mdx
index 4b2857c4f7..b4e81fde83 100644
--- a/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-toc.mdx
+++ b/website/versioned_docs/version-2.0.1/guides/markdown-features/markdown-features-toc.mdx
@@ -102,7 +102,7 @@ It is also possible to display an inline table of contents directly inside a Mar
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.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
@@ -129,7 +129,7 @@ declare const toc: {
Note that the `toc` global is a flat array, so you can easily cut out unwanted nodes or insert extra nodes, and create a new TOC tree.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
diff --git a/website/versioned_docs/version-2.0.1/introduction.mdx b/website/versioned_docs/version-2.0.1/introduction.mdx
index 46b616c7d5..85d26b6a76 100644
--- a/website/versioned_docs/version-2.0.1/introduction.mdx
+++ b/website/versioned_docs/version-2.0.1/introduction.mdx
@@ -129,18 +129,6 @@ Docusaurus 2 is born to be compassionately accessible to all your users, and lig
We believe that, as developers, knowing how a library works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various components of Docusaurus with the hope that users reading it will gain a deeper understanding of the tool and be even more proficient in using it.
-
-
## Comparison with other tools {#comparison-with-other-tools}
Across all static site generators, Docusaurus has a unique focus on documentation sites and has many out-of-the-box features.
diff --git a/website/versioned_docs/version-2.0.1/search.mdx b/website/versioned_docs/version-2.0.1/search.mdx
index 66e6b3c13a..c1dad98ff9 100644
--- a/website/versioned_docs/version-2.0.1/search.mdx
+++ b/website/versioned_docs/version-2.0.1/search.mdx
@@ -241,7 +241,7 @@ Still, you can reuse the [Infima CSS variables](styling-layout.mdx#styling-your-
### Customizing the Algolia search behavior {#customizing-the-algolia-search-behavior}
-
+{/* TODO: update options link once the documentation is available on the DocSearch website */}
Algolia DocSearch supports a [list of options](https://autocomplete-experimental.netlify.app/docs/DocSearchModal#reference) that you can pass to the `algolia` field in the `docusaurus.config.js` file.
diff --git a/website/versioned_docs/version-2.1.0/api/docusaurus.config.js.mdx b/website/versioned_docs/version-2.1.0/api/docusaurus.config.js.mdx
index 466bf06f92..a6c5215fc2 100644
--- a/website/versioned_docs/version-2.1.0/api/docusaurus.config.js.mdx
+++ b/website/versioned_docs/version-2.1.0/api/docusaurus.config.js.mdx
@@ -123,7 +123,7 @@ The i18n configuration object to [localize your site](../i18n/i18n-introduction.
Example:
-
+{/* cSpell:ignore فارسی */}
```js title="docusaurus.config.js"
module.exports = {
diff --git a/website/versioned_docs/version-2.1.0/blog.mdx b/website/versioned_docs/version-2.1.0/blog.mdx
index a2262e2f11..a59ff92e8c 100644
--- a/website/versioned_docs/version-2.1.0/blog.mdx
+++ b/website/versioned_docs/version-2.1.0/blog.mdx
@@ -63,7 +63,7 @@ hide_table_of_contents: false
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
-
+
This is my first post on Docusaurus 2.
@@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front-
The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed.
-Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example:
+Use the `{/*truncate*/}` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `{/*truncate*/}` will be part of the summary. For example:
```md
---
@@ -87,7 +87,7 @@ All these will be part of the blog post summary.
Even this.
-
+
But anything from here on down will not be.
diff --git a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx
index f4c00f7c3f..0ea3e6b907 100644
--- a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx
+++ b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-admonitions.mdx
@@ -87,7 +87,7 @@ Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.
-
+{/* prettier-ignore */}
```md
:::note
diff --git a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-react.mdx
index a8d76f1067..ea6fbd9e48 100644
--- a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-react.mdx
+++ b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-react.mdx
@@ -76,7 +76,7 @@ I can write **Markdown** alongside my _JSX_!
Since all doc files are parsed using MDX, anything that looks like HTML is actually JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects.
-
+{/* prettier-ignore */}
```jsx
/* Instead of this: */
Foo
@@ -94,7 +94,7 @@ In addition, MDX is not [100% compatible with CommonMark](https://github.com/fac
You can also import your own components defined in other files or third-party components installed via npm.
-
+{/* prettier-ignore */}
```md
import TOCInline from '@theme/TOCInline';
@@ -339,7 +339,7 @@ Use JSX within JSX tag, or move the Markdown to the outer layer:
```
-
+{/* prettier-ignore */}
```jsx
**Bold still doesn't work**
@@ -365,7 +365,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -395,7 +395,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -425,7 +425,7 @@ Don't indent:
```
-
+{/* prettier-ignore */}
```jsx
@@ -461,14 +461,13 @@ npm install --save raw-loader
Now you can import code snippets from another file as it is:
-
+{/* prettier-ignore */}
```jsx title="myMarkdownFile.mdx"
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';
{MyComponentSource}
```
-
```mdx-code-block
import CodeBlock from '@theme/CodeBlock';
@@ -507,13 +506,12 @@ By convention, using the **`_` filename prefix** will not create any doc page an
This is text some content from `_markdown-partial-example.mdx`.
```
-
+{/* prettier-ignore */}
```jsx title="someOtherDoc.mdx"
import PartialExample from './_markdown-partial-example.mdx';
```
-
```mdx-code-block
import PartialExample from './_markdown-partial-example.mdx';
diff --git a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-tabs.mdx b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-tabs.mdx
index 897f54a8a7..987f1067a3 100644
--- a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-tabs.mdx
+++ b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-tabs.mdx
@@ -15,7 +15,7 @@ import styles from './markdown-features-tabs-styles.module.css';
Docusaurus provides the `
` component that you can use in Markdown thanks to [MDX](./markdown-features-react.mdx):
-
+{/* prettier-ignore */}
```jsx
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -32,7 +32,6 @@ import TabItem from '@theme/TabItem';
```
-
```mdx-code-block
@@ -250,7 +249,7 @@ You might want to customize the appearance of a certain set of tabs. You can pas
You can also customize each tab heading independently by using the `attributes` field. The extra props can be passed to the headings either through the `values` prop in `Tabs`, or props of each `TabItem`—in the same way as you declare `label`.
-
+{/* prettier-ignore */}
```jsx title="some-doc.mdx"
import styles from './styles.module.css';
@@ -266,7 +265,6 @@ import styles from './styles.module.css';
```
-
```css title="styles.module.css"
.red {
diff --git a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-toc.mdx b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-toc.mdx
index 4b2857c4f7..b4e81fde83 100644
--- a/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-toc.mdx
+++ b/website/versioned_docs/version-2.1.0/guides/markdown-features/markdown-features-toc.mdx
@@ -102,7 +102,7 @@ It is also possible to display an inline table of contents directly inside a Mar
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.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
@@ -129,7 +129,7 @@ declare const toc: {
Note that the `toc` global is a flat array, so you can easily cut out unwanted nodes or insert extra nodes, and create a new TOC tree.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
diff --git a/website/versioned_docs/version-2.1.0/introduction.mdx b/website/versioned_docs/version-2.1.0/introduction.mdx
index 46b616c7d5..85d26b6a76 100644
--- a/website/versioned_docs/version-2.1.0/introduction.mdx
+++ b/website/versioned_docs/version-2.1.0/introduction.mdx
@@ -129,18 +129,6 @@ Docusaurus 2 is born to be compassionately accessible to all your users, and lig
We believe that, as developers, knowing how a library works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various components of Docusaurus with the hope that users reading it will gain a deeper understanding of the tool and be even more proficient in using it.
-
-
## Comparison with other tools {#comparison-with-other-tools}
Across all static site generators, Docusaurus has a unique focus on documentation sites and has many out-of-the-box features.
diff --git a/website/versioned_docs/version-2.1.0/search.mdx b/website/versioned_docs/version-2.1.0/search.mdx
index 66e6b3c13a..c1dad98ff9 100644
--- a/website/versioned_docs/version-2.1.0/search.mdx
+++ b/website/versioned_docs/version-2.1.0/search.mdx
@@ -241,7 +241,7 @@ Still, you can reuse the [Infima CSS variables](styling-layout.mdx#styling-your-
### Customizing the Algolia search behavior {#customizing-the-algolia-search-behavior}
-
+{/* TODO: update options link once the documentation is available on the DocSearch website */}
Algolia DocSearch supports a [list of options](https://autocomplete-experimental.netlify.app/docs/DocSearchModal#reference) that you can pass to the `algolia` field in the `docusaurus.config.js` file.
diff --git a/website/versioned_docs/version-2.2.0/api/docusaurus.config.js.mdx b/website/versioned_docs/version-2.2.0/api/docusaurus.config.js.mdx
index 052baa5b06..0601b2e39e 100644
--- a/website/versioned_docs/version-2.2.0/api/docusaurus.config.js.mdx
+++ b/website/versioned_docs/version-2.2.0/api/docusaurus.config.js.mdx
@@ -123,7 +123,7 @@ The i18n configuration object to [localize your site](../i18n/i18n-introduction.
Example:
-
+{/* cSpell:ignore فارسی */}
```js title="docusaurus.config.js"
module.exports = {
diff --git a/website/versioned_docs/version-2.2.0/blog.mdx b/website/versioned_docs/version-2.2.0/blog.mdx
index a2262e2f11..a59ff92e8c 100644
--- a/website/versioned_docs/version-2.2.0/blog.mdx
+++ b/website/versioned_docs/version-2.2.0/blog.mdx
@@ -63,7 +63,7 @@ hide_table_of_contents: false
Welcome to this blog. This blog is created with [**Docusaurus 2**](https://docusaurus.io/).
-
+
This is my first post on Docusaurus 2.
@@ -76,7 +76,7 @@ The [front matter](./guides/markdown-features/markdown-features-intro.mdx#front-
The blog's index page (by default, it is at `/blog`) is the _blog list page_, where all blog posts are collectively displayed.
-Use the `` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `` will be part of the summary. For example:
+Use the `{/*truncate*/}` marker in your blog post to represent what will be shown as the summary when viewing all published blog posts. Anything above `{/*truncate*/}` will be part of the summary. For example:
```md
---
@@ -87,7 +87,7 @@ All these will be part of the blog post summary.
Even this.
-
+
But anything from here on down will not be.
diff --git a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx
index f4c00f7c3f..0ea3e6b907 100644
--- a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx
+++ b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-admonitions.mdx
@@ -87,7 +87,7 @@ Some **content** with _Markdown_ `syntax`. Check [this `api`](#).
If you use [Prettier](https://prettier.io) to format your Markdown files, Prettier might auto-format your code to invalid admonition syntax. To avoid this problem, add empty lines around the starting and ending directives. This is also why the examples we show here all have empty lines around the content.
-
+{/* prettier-ignore */}
```md
:::note
diff --git a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-react.mdx b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-react.mdx
index a8d76f1067..5abc552baa 100644
--- a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-react.mdx
+++ b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-react.mdx
@@ -76,7 +76,7 @@ I can write **Markdown** alongside my _JSX_!
Since all doc files are parsed using MDX, anything that looks like HTML is actually JSX. Therefore, if you need to inline-style a component, follow JSX flavor and provide style objects.
-
+{/* prettier-ignore */}
```jsx
/* Instead of this: */
Foo
@@ -94,7 +94,7 @@ In addition, MDX is not [100% compatible with CommonMark](https://github.com/fac
You can also import your own components defined in other files or third-party components installed via npm.
-
+{/* prettier-ignore */}
```md
import TOCInline from '@theme/TOCInline';
@@ -339,7 +339,7 @@ Use JSX within JSX tag, or move the Markdown to the outer layer:
```
-
+{/* prettier-ignore */}
```jsx
**Bold still doesn't work**
@@ -365,7 +365,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -395,7 +395,7 @@ Add an empty new line:
```
-
+{/* prettier-ignore */}
```jsx
@@ -425,7 +425,7 @@ Don't indent:
```
-
+{/* prettier-ignore */}
```jsx
@@ -461,14 +461,13 @@ npm install --save raw-loader
Now you can import code snippets from another file as it is:
-
+
```jsx title="myMarkdownFile.mdx"
import CodeBlock from '@theme/CodeBlock';
import MyComponentSource from '!!raw-loader!./myComponent';
{MyComponentSource}
```
-
```mdx-code-block
import CodeBlock from '@theme/CodeBlock';
@@ -507,13 +506,12 @@ By convention, using the **`_` filename prefix** will not create any doc page an
This is text some content from `_markdown-partial-example.mdx`.
```
-
+{/* prettier-ignore */}
```jsx title="someOtherDoc.mdx"
import PartialExample from './_markdown-partial-example.mdx';
```
-
```mdx-code-block
import PartialExample from './_markdown-partial-example.mdx';
diff --git a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-tabs.mdx b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-tabs.mdx
index 897f54a8a7..987f1067a3 100644
--- a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-tabs.mdx
+++ b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-tabs.mdx
@@ -15,7 +15,7 @@ import styles from './markdown-features-tabs-styles.module.css';
Docusaurus provides the `
` component that you can use in Markdown thanks to [MDX](./markdown-features-react.mdx):
-
+{/* prettier-ignore */}
```jsx
import Tabs from '@theme/Tabs';
import TabItem from '@theme/TabItem';
@@ -32,7 +32,6 @@ import TabItem from '@theme/TabItem';
```
-
```mdx-code-block
@@ -250,7 +249,7 @@ You might want to customize the appearance of a certain set of tabs. You can pas
You can also customize each tab heading independently by using the `attributes` field. The extra props can be passed to the headings either through the `values` prop in `Tabs`, or props of each `TabItem`—in the same way as you declare `label`.
-
+{/* prettier-ignore */}
```jsx title="some-doc.mdx"
import styles from './styles.module.css';
@@ -266,7 +265,6 @@ import styles from './styles.module.css';
```
-
```css title="styles.module.css"
.red {
diff --git a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-toc.mdx b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-toc.mdx
index 4b2857c4f7..b4e81fde83 100644
--- a/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-toc.mdx
+++ b/website/versioned_docs/version-2.2.0/guides/markdown-features/markdown-features-toc.mdx
@@ -102,7 +102,7 @@ It is also possible to display an inline table of contents directly inside a Mar
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.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
@@ -129,7 +129,7 @@ declare const toc: {
Note that the `toc` global is a flat array, so you can easily cut out unwanted nodes or insert extra nodes, and create a new TOC tree.
-
+{/* prettier-ignore */}
```jsx
import TOCInline from '@theme/TOCInline';
diff --git a/website/versioned_docs/version-2.2.0/introduction.mdx b/website/versioned_docs/version-2.2.0/introduction.mdx
index 46b616c7d5..85d26b6a76 100644
--- a/website/versioned_docs/version-2.2.0/introduction.mdx
+++ b/website/versioned_docs/version-2.2.0/introduction.mdx
@@ -129,18 +129,6 @@ Docusaurus 2 is born to be compassionately accessible to all your users, and lig
We believe that, as developers, knowing how a library works helps us become better at using it. Hence we're dedicating effort to explaining the architecture and various components of Docusaurus with the hope that users reading it will gain a deeper understanding of the tool and be even more proficient in using it.
-
-
## Comparison with other tools {#comparison-with-other-tools}
Across all static site generators, Docusaurus has a unique focus on documentation sites and has many out-of-the-box features.
diff --git a/website/versioned_docs/version-2.2.0/search.mdx b/website/versioned_docs/version-2.2.0/search.mdx
index 4febd41378..ddef7a4a09 100644
--- a/website/versioned_docs/version-2.2.0/search.mdx
+++ b/website/versioned_docs/version-2.2.0/search.mdx
@@ -241,7 +241,7 @@ Still, you can reuse the [Infima CSS variables](styling-layout.mdx#styling-your-
### Customizing the Algolia search behavior {#customizing-the-algolia-search-behavior}
-
+{/* TODO: update options link once the documentation is available on the DocSearch website */}
Algolia DocSearch supports a [list of options](https://autocomplete-experimental.netlify.app/docs/DocSearchModal#reference) that you can pass to the `algolia` field in the `docusaurus.config.js` file.