diff --git a/packages/docusaurus-plugin-client-redirects/src/index.ts b/packages/docusaurus-plugin-client-redirects/src/index.ts index 991f739efe0f..5b64560bac04 100644 --- a/packages/docusaurus-plugin-client-redirects/src/index.ts +++ b/packages/docusaurus-plugin-client-redirects/src/index.ts @@ -34,8 +34,6 @@ export default function pluginClientRedirectsPages( siteConfig: props.siteConfig, }; - console.log({propsBaseUrl: props.baseUrl}); - const redirects: RedirectItem[] = collectRedirects( pluginContext, trailingSlash, diff --git a/website/docs/advanced/routing.mdx b/website/docs/advanced/routing.mdx index 73fe534e848f..5bf943072ba6 100644 --- a/website/docs/advanced/routing.mdx +++ b/website/docs/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/docs/api/docusaurus.config.js.mdx b/website/docs/api/docusaurus.config.js.mdx index 4a792231fd61..d1ca832e639e 100644 --- a/website/docs/api/docusaurus.config.js.mdx +++ b/website/docs/api/docusaurus.config.js.mdx @@ -4,13 +4,13 @@ description: API reference for Docusaurus configuration file. slug: /api/docusaurus-config --- -import APITable from '@site/src/components/APITable'; - # `docusaurus.config.js` +import APITable from '@site/src/components/APITable'; + :::info -Refer to the Getting Started [**Configuration**](docs/configuration.mdx) for examples. +Refer to the Getting Started [**Configuration**](../configuration.mdx) for examples. ::: @@ -42,7 +42,7 @@ module.exports = async function createConfigAsync() { :::tip -Refer to [**Syntax to declare `docusaurus.config.js`**](docs/configuration.mdx#syntax-to-declare-docusaurus-config) for a more exhaustive list of examples and explanations. +Refer to [**Syntax to declare `docusaurus.config.js`**](../configuration.mdx#syntax-to-declare-docusaurus-config) for a more exhaustive list of examples and explanations. ::: diff --git a/website/docs/api/plugins/plugin-debug.mdx b/website/docs/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/docs/api/plugins/plugin-debug.mdx +++ b/website/docs/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/docs/api/themes/theme-classic.mdx b/website/docs/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/docs/api/themes/theme-classic.mdx +++ b/website/docs/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/docs/deployment.mdx b/website/docs/deployment.mdx index 8f35d38c5d36..4e1945895aef 100644 --- a/website/docs/deployment.mdx +++ b/website/docs/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/docs/guides/creating-pages.mdx b/website/docs/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/docs/guides/creating-pages.mdx +++ b/website/docs/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/docs/i18n/i18n-crowdin.mdx b/website/docs/i18n/i18n-crowdin.mdx index f60b2a510286..b57dbb71e093 100644 --- a/website/docs/i18n/i18n-crowdin.mdx +++ b/website/docs/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/docs/i18n/i18n-tutorial.mdx b/website/docs/i18n/i18n-tutorial.mdx index c66fb976aaae..7e9de4cbb799 100644 --- a/website/docs/i18n/i18n-tutorial.mdx +++ b/website/docs/i18n/i18n-tutorial.mdx @@ -84,7 +84,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -472,8 +472,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/docs/installation.mdx b/website/docs/installation.mdx index e55385448d92..429dc9c7f8e9 100644 --- a/website/docs/installation.mdx +++ b/website/docs/installation.mdx @@ -135,7 +135,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/docs/introduction.mdx b/website/docs/introduction.mdx index 383563a61f19..db4e2caf58d7 100644 --- a/website/docs/introduction.mdx +++ b/website/docs/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/docs/migration/migration-manual.mdx b/website/docs/migration/migration-manual.mdx index 49a7cdd1fce4..a44c4ac8ca17 100644 --- a/website/docs/migration/migration-manual.mdx +++ b/website/docs/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/docusaurus.config.js b/website/docusaurus.config.js index 59aa5dc2c465..36b190cb846b 100644 --- a/website/docusaurus.config.js +++ b/website/docusaurus.config.js @@ -164,15 +164,21 @@ module.exports = async function createConfigAsync() { // comments: false, }, preprocessor: ({filePath, fileContent}) => { + let result = fileContent; + + result = result.replaceAll('{/_', '{/*'); + result = result.replaceAll('_/}', '*/}'); + if (isDev) { // "vscode://file/${projectPath}${filePath}:${line}:${column}", // "webstorm://open?file=${projectPath}${filePath}&line=${line}&column=${column}", const vscodeLink = `vscode://file/${filePath}`; const webstormLink = `webstorm://open?file=${filePath}`; const intellijLink = `idea://open?file=${filePath}`; - return `${fileContent}\n\n---\n\n**DEV**: open this file in [VSCode](<${vscodeLink}>) | [WebStorm](<${webstormLink}>) | [IntelliJ](<${intellijLink}>)\n`; + result = `${result}\n\n---\n\n**DEV**: open this file in [VSCode](<${vscodeLink}>) | [WebStorm](<${webstormLink}>) | [IntelliJ](<${intellijLink}>)\n`; } - return fileContent; + + return result; }, }, onBrokenLinks: 'throw', diff --git a/website/versioned_docs/version-2.0.1/advanced/routing.mdx b/website/versioned_docs/version-2.0.1/advanced/routing.mdx index cb3992c2d5fa..e6513637e379 100644 --- a/website/versioned_docs/version-2.0.1/advanced/routing.mdx +++ b/website/versioned_docs/version-2.0.1/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-2.0.1/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-2.0.1/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-2.0.1/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-2.0.1/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-2.0.1/api/themes/theme-classic.mdx b/website/versioned_docs/version-2.0.1/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-2.0.1/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-2.0.1/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-2.0.1/deployment.mdx b/website/versioned_docs/version-2.0.1/deployment.mdx index 7d10a2778209..3a20f0b64b1b 100644 --- a/website/versioned_docs/version-2.0.1/deployment.mdx +++ b/website/versioned_docs/version-2.0.1/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-2.0.1/guides/creating-pages.mdx b/website/versioned_docs/version-2.0.1/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-2.0.1/guides/creating-pages.mdx +++ b/website/versioned_docs/version-2.0.1/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-2.0.1/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.0.1/i18n/i18n-crowdin.mdx index 455d68c1574d..bd0306091f62 100644 --- a/website/versioned_docs/version-2.0.1/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.0.1/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-2.0.1/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-2.0.1/i18n/i18n-tutorial.mdx index ab3c403286ab..1cdd4e6e4bc0 100644 --- a/website/versioned_docs/version-2.0.1/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-2.0.1/i18n/i18n-tutorial.mdx @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -464,8 +464,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-2.0.1/installation.mdx b/website/versioned_docs/version-2.0.1/installation.mdx index 4205ba15f876..7a0da32aee28 100644 --- a/website/versioned_docs/version-2.0.1/installation.mdx +++ b/website/versioned_docs/version-2.0.1/installation.mdx @@ -163,7 +163,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-2.0.1/introduction.mdx b/website/versioned_docs/version-2.0.1/introduction.mdx index a03b487c78b0..94b299ebec12 100644 --- a/website/versioned_docs/version-2.0.1/introduction.mdx +++ b/website/versioned_docs/version-2.0.1/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-2.0.1/migration/migration-manual.mdx b/website/versioned_docs/version-2.0.1/migration/migration-manual.mdx index 95a8c47d0465..517d158f199e 100644 --- a/website/versioned_docs/version-2.0.1/migration/migration-manual.mdx +++ b/website/versioned_docs/version-2.0.1/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/versioned_docs/version-2.1.0/advanced/routing.mdx b/website/versioned_docs/version-2.1.0/advanced/routing.mdx index cb3992c2d5fa..e6513637e379 100644 --- a/website/versioned_docs/version-2.1.0/advanced/routing.mdx +++ b/website/versioned_docs/version-2.1.0/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-2.1.0/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-2.1.0/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-2.1.0/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-2.1.0/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-2.1.0/api/themes/theme-classic.mdx b/website/versioned_docs/version-2.1.0/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-2.1.0/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-2.1.0/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-2.1.0/deployment.mdx b/website/versioned_docs/version-2.1.0/deployment.mdx index 7d10a2778209..3a20f0b64b1b 100644 --- a/website/versioned_docs/version-2.1.0/deployment.mdx +++ b/website/versioned_docs/version-2.1.0/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-2.1.0/guides/creating-pages.mdx b/website/versioned_docs/version-2.1.0/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-2.1.0/guides/creating-pages.mdx +++ b/website/versioned_docs/version-2.1.0/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-2.1.0/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.1.0/i18n/i18n-crowdin.mdx index 455d68c1574d..bd0306091f62 100644 --- a/website/versioned_docs/version-2.1.0/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.1.0/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-2.1.0/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-2.1.0/i18n/i18n-tutorial.mdx index ab3c403286ab..1cdd4e6e4bc0 100644 --- a/website/versioned_docs/version-2.1.0/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-2.1.0/i18n/i18n-tutorial.mdx @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -464,8 +464,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-2.1.0/installation.mdx b/website/versioned_docs/version-2.1.0/installation.mdx index 4205ba15f876..7a0da32aee28 100644 --- a/website/versioned_docs/version-2.1.0/installation.mdx +++ b/website/versioned_docs/version-2.1.0/installation.mdx @@ -163,7 +163,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-2.1.0/introduction.mdx b/website/versioned_docs/version-2.1.0/introduction.mdx index a03b487c78b0..94b299ebec12 100644 --- a/website/versioned_docs/version-2.1.0/introduction.mdx +++ b/website/versioned_docs/version-2.1.0/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-2.1.0/migration/migration-manual.mdx b/website/versioned_docs/version-2.1.0/migration/migration-manual.mdx index 95a8c47d0465..517d158f199e 100644 --- a/website/versioned_docs/version-2.1.0/migration/migration-manual.mdx +++ b/website/versioned_docs/version-2.1.0/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/versioned_docs/version-2.2.0/advanced/routing.mdx b/website/versioned_docs/version-2.2.0/advanced/routing.mdx index cb3992c2d5fa..e6513637e379 100644 --- a/website/versioned_docs/version-2.2.0/advanced/routing.mdx +++ b/website/versioned_docs/version-2.2.0/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-2.2.0/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-2.2.0/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-2.2.0/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-2.2.0/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-2.2.0/api/themes/theme-classic.mdx b/website/versioned_docs/version-2.2.0/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-2.2.0/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-2.2.0/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-2.2.0/deployment.mdx b/website/versioned_docs/version-2.2.0/deployment.mdx index 7d10a2778209..3a20f0b64b1b 100644 --- a/website/versioned_docs/version-2.2.0/deployment.mdx +++ b/website/versioned_docs/version-2.2.0/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-2.2.0/guides/creating-pages.mdx b/website/versioned_docs/version-2.2.0/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-2.2.0/guides/creating-pages.mdx +++ b/website/versioned_docs/version-2.2.0/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-2.2.0/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.2.0/i18n/i18n-crowdin.mdx index 455d68c1574d..bd0306091f62 100644 --- a/website/versioned_docs/version-2.2.0/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.2.0/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-2.2.0/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-2.2.0/i18n/i18n-tutorial.mdx index ab3c403286ab..1cdd4e6e4bc0 100644 --- a/website/versioned_docs/version-2.2.0/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-2.2.0/i18n/i18n-tutorial.mdx @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -464,8 +464,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-2.2.0/installation.mdx b/website/versioned_docs/version-2.2.0/installation.mdx index 4205ba15f876..7a0da32aee28 100644 --- a/website/versioned_docs/version-2.2.0/installation.mdx +++ b/website/versioned_docs/version-2.2.0/installation.mdx @@ -163,7 +163,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-2.2.0/introduction.mdx b/website/versioned_docs/version-2.2.0/introduction.mdx index a03b487c78b0..94b299ebec12 100644 --- a/website/versioned_docs/version-2.2.0/introduction.mdx +++ b/website/versioned_docs/version-2.2.0/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-2.2.0/migration/migration-manual.mdx b/website/versioned_docs/version-2.2.0/migration/migration-manual.mdx index 95a8c47d0465..517d158f199e 100644 --- a/website/versioned_docs/version-2.2.0/migration/migration-manual.mdx +++ b/website/versioned_docs/version-2.2.0/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/versioned_docs/version-2.3.1/advanced/routing.mdx b/website/versioned_docs/version-2.3.1/advanced/routing.mdx index cb3992c2d5fa..e6513637e379 100644 --- a/website/versioned_docs/version-2.3.1/advanced/routing.mdx +++ b/website/versioned_docs/version-2.3.1/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-2.3.1/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-2.3.1/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-2.3.1/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-2.3.1/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-2.3.1/api/themes/theme-classic.mdx b/website/versioned_docs/version-2.3.1/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-2.3.1/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-2.3.1/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-2.3.1/deployment.mdx b/website/versioned_docs/version-2.3.1/deployment.mdx index 7d10a2778209..3a20f0b64b1b 100644 --- a/website/versioned_docs/version-2.3.1/deployment.mdx +++ b/website/versioned_docs/version-2.3.1/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-2.3.1/guides/creating-pages.mdx b/website/versioned_docs/version-2.3.1/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-2.3.1/guides/creating-pages.mdx +++ b/website/versioned_docs/version-2.3.1/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-2.3.1/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.3.1/i18n/i18n-crowdin.mdx index 455d68c1574d..bd0306091f62 100644 --- a/website/versioned_docs/version-2.3.1/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.3.1/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-2.3.1/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-2.3.1/i18n/i18n-tutorial.mdx index ab3c403286ab..1cdd4e6e4bc0 100644 --- a/website/versioned_docs/version-2.3.1/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-2.3.1/i18n/i18n-tutorial.mdx @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -464,8 +464,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-2.3.1/installation.mdx b/website/versioned_docs/version-2.3.1/installation.mdx index 4205ba15f876..7a0da32aee28 100644 --- a/website/versioned_docs/version-2.3.1/installation.mdx +++ b/website/versioned_docs/version-2.3.1/installation.mdx @@ -163,7 +163,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-2.3.1/introduction.mdx b/website/versioned_docs/version-2.3.1/introduction.mdx index 2aeeba0948a8..0ee7ebdaee29 100644 --- a/website/versioned_docs/version-2.3.1/introduction.mdx +++ b/website/versioned_docs/version-2.3.1/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-2.3.1/migration/migration-manual.mdx b/website/versioned_docs/version-2.3.1/migration/migration-manual.mdx index 95a8c47d0465..517d158f199e 100644 --- a/website/versioned_docs/version-2.3.1/migration/migration-manual.mdx +++ b/website/versioned_docs/version-2.3.1/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/versioned_docs/version-2.4.1/advanced/routing.mdx b/website/versioned_docs/version-2.4.1/advanced/routing.mdx index cb3992c2d5fa..e6513637e379 100644 --- a/website/versioned_docs/version-2.4.1/advanced/routing.mdx +++ b/website/versioned_docs/version-2.4.1/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-2.4.1/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-2.4.1/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-2.4.1/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-2.4.1/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-2.4.1/api/themes/theme-classic.mdx b/website/versioned_docs/version-2.4.1/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-2.4.1/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-2.4.1/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-2.4.1/deployment.mdx b/website/versioned_docs/version-2.4.1/deployment.mdx index 7d10a2778209..3a20f0b64b1b 100644 --- a/website/versioned_docs/version-2.4.1/deployment.mdx +++ b/website/versioned_docs/version-2.4.1/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-2.4.1/guides/creating-pages.mdx b/website/versioned_docs/version-2.4.1/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-2.4.1/guides/creating-pages.mdx +++ b/website/versioned_docs/version-2.4.1/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-2.4.1/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-2.4.1/i18n/i18n-crowdin.mdx index 455d68c1574d..bd0306091f62 100644 --- a/website/versioned_docs/version-2.4.1/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-2.4.1/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-2.4.1/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-2.4.1/i18n/i18n-tutorial.mdx index ab3c403286ab..1cdd4e6e4bc0 100644 --- a/website/versioned_docs/version-2.4.1/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-2.4.1/i18n/i18n-tutorial.mdx @@ -76,7 +76,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -464,8 +464,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-2.4.1/installation.mdx b/website/versioned_docs/version-2.4.1/installation.mdx index 3cc88f43c303..175a4bd22bd7 100644 --- a/website/versioned_docs/version-2.4.1/installation.mdx +++ b/website/versioned_docs/version-2.4.1/installation.mdx @@ -135,7 +135,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-2.4.1/introduction.mdx b/website/versioned_docs/version-2.4.1/introduction.mdx index 383563a61f19..db4e2caf58d7 100644 --- a/website/versioned_docs/version-2.4.1/introduction.mdx +++ b/website/versioned_docs/version-2.4.1/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-2.4.1/migration/migration-manual.mdx b/website/versioned_docs/version-2.4.1/migration/migration-manual.mdx index 49a7cdd1fce4..a44c4ac8ca17 100644 --- a/website/versioned_docs/version-2.4.1/migration/migration-manual.mdx +++ b/website/versioned_docs/version-2.4.1/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: diff --git a/website/versioned_docs/version-3.0.0-alpha.0/advanced/routing.mdx b/website/versioned_docs/version-3.0.0-alpha.0/advanced/routing.mdx index 73fe534e848f..5bf943072ba6 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/advanced/routing.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/advanced/routing.mdx @@ -274,8 +274,8 @@ If you put some HTML pages under the `static` folder, they will be copied to the -- [/pure-html](/pure-html) -- [pathname:///pure-html](pathname:///pure-html) +- [`/pure-html`](/pure-html) +- [`pathname:///pure-html`](pathname:///pure-html) diff --git a/website/versioned_docs/version-3.0.0-alpha.0/api/docusaurus.config.js.mdx b/website/versioned_docs/version-3.0.0-alpha.0/api/docusaurus.config.js.mdx index d86a697b1a08..80ca18d0693b 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/api/docusaurus.config.js.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/api/docusaurus.config.js.mdx @@ -8,7 +8,7 @@ slug: /api/docusaurus-config :::info -Refer to the Getting Started [**Configuration**](docs/configuration.mdx) for examples. +Refer to the Getting Started [**Configuration**](../configuration.mdx) for examples. ::: @@ -40,7 +40,7 @@ module.exports = async function createConfigAsync() { :::tip -Refer to [**Syntax to declare `docusaurus.config.js`**](docs/configuration.mdx#syntax-to-declare-docusaurus-config) for a more exhaustive list of examples and explanations. +Refer to [**Syntax to declare `docusaurus.config.js`**](../configuration.mdx#syntax-to-declare-docusaurus-config) for a more exhaustive list of examples and explanations. ::: diff --git a/website/versioned_docs/version-3.0.0-alpha.0/api/plugins/plugin-debug.mdx b/website/versioned_docs/version-3.0.0-alpha.0/api/plugins/plugin-debug.mdx index e6ba7164b765..7cbbdcbe94a2 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/api/plugins/plugin-debug.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/api/plugins/plugin-debug.mdx @@ -10,7 +10,7 @@ import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; ``` -The debug plugin will display useful debug information at [http://localhost:3000/\_\_docusaurus/debug](http://localhost:3000/__docusaurus/debug). +The debug plugin will display useful debug information at [`http://localhost:3000/__docusaurus/debug`](http://localhost:3000/__docusaurus/debug). It is mostly useful for plugin authors, that will be able to inspect more easily the content of the `.docusaurus` folder (like the creates routes), but also be able to inspect data structures that are never written to disk, like the plugin data loaded through the `contentLoaded` lifecycle. diff --git a/website/versioned_docs/version-3.0.0-alpha.0/api/themes/theme-classic.mdx b/website/versioned_docs/version-3.0.0-alpha.0/api/themes/theme-classic.mdx index 12d812affbea..14395396353e 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/api/themes/theme-classic.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/api/themes/theme-classic.mdx @@ -3,10 +3,10 @@ sidebar_position: 2 slug: /api/themes/@docusaurus/theme-classic --- -import APITable from '@site/src/components/APITable'; - # 📦 theme-classic +import APITable from '@site/src/components/APITable'; + The classic theme for Docusaurus. You can refer to the [theme configuration page](theme-configuration.mdx) for more details on the configuration. diff --git a/website/versioned_docs/version-3.0.0-alpha.0/deployment.mdx b/website/versioned_docs/version-3.0.0-alpha.0/deployment.mdx index 512c30b6cb71..67a5c0280241 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/deployment.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/deployment.mdx @@ -41,7 +41,7 @@ It is important to test your build locally before deploying it for production. D npm run serve ``` -By default, this will load your site at [http://localhost:3000/](http://localhost:3000/). +By default, this will load your site at [`http://localhost:3000/`](http://localhost:3000/). ## Trailing slash configuration {#trailing-slashes} diff --git a/website/versioned_docs/version-3.0.0-alpha.0/guides/creating-pages.mdx b/website/versioned_docs/version-3.0.0-alpha.0/guides/creating-pages.mdx index 75cfb669c7bb..30ffdb9faf68 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/guides/creating-pages.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/guides/creating-pages.mdx @@ -51,7 +51,7 @@ export default function Hello() { } ``` -Once you save the file, the development server will automatically reload the changes. Now open [http://localhost:3000/helloReact](http://localhost:3000/helloReact) and you will see the new page you just created. +Once you save the file, the development server will automatically reload the changes. Now open [`http://localhost:3000/helloReact`](http://localhost:3000/helloReact) and you will see the new page you just created. Each page doesn't come with any styling. You will need to import the `Layout` component from `@theme/Layout` and wrap your contents within that component if you want the navbar and/or footer to appear. @@ -77,7 +77,7 @@ hide_table_of_contents: true How are you? ``` -In the same way, a page will be created at [http://localhost:3000/helloMarkdown](http://localhost:3000/helloMarkdown). +In the same way, a page will be created at [`http://localhost:3000/helloMarkdown`](http://localhost:3000/helloMarkdown). Markdown pages are less flexible than React pages because it always uses the theme layout. diff --git a/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-crowdin.mdx b/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-crowdin.mdx index f60b2a510286..b57dbb71e093 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-crowdin.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-crowdin.mdx @@ -290,7 +290,7 @@ Start your site on the French locale: npm run start -- --locale fr ``` -Make sure that your website is now translated in French at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Make sure that your website is now translated in French at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). ### Automate with CI {#automate-with-ci} diff --git a/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-tutorial.mdx b/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-tutorial.mdx index c66fb976aaae..7e9de4cbb799 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-tutorial.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/i18n/i18n-tutorial.mdx @@ -84,7 +84,7 @@ Start your localized site in dev mode, using the locale of your choice: npm run start -- --locale fr ``` -Your site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/). +Your site is accessible at [`http://localhost:3000/fr/`](http://localhost:3000/fr/). We haven't provided any translation yet, so the site is mostly untranslated. @@ -472,8 +472,8 @@ You can now [deploy](../deployment.mdx) the `build` folder to the static hosting The Docusaurus v2 website uses this strategy: -- [https://docusaurus.io](https://docusaurus.io) -- [https://docusaurus.io/fr](https://docusaurus.io/fr) +- [`https://docusaurus.io`](https://docusaurus.io) +- [`https://docusaurus.io/fr`](https://docusaurus.io/fr) ::: diff --git a/website/versioned_docs/version-3.0.0-alpha.0/installation.mdx b/website/versioned_docs/version-3.0.0-alpha.0/installation.mdx index 04c6258d352e..aa460aa88abb 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/installation.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/installation.mdx @@ -135,7 +135,7 @@ cd my-website npm run start ``` -By default, a browser window will open at [http://localhost:3000](http://localhost:3000). +By default, a browser window will open at [`http://localhost:3000`](http://localhost:3000). Congratulations! You have just created your first Docusaurus site! Browse around the site to see what's available. diff --git a/website/versioned_docs/version-3.0.0-alpha.0/introduction.mdx b/website/versioned_docs/version-3.0.0-alpha.0/introduction.mdx index 383563a61f19..db4e2caf58d7 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/introduction.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/introduction.mdx @@ -36,7 +36,7 @@ cd my-website npx docusaurus start ``` -Open [http://localhost:3000](http://localhost:3000) and follow the tutorial. +Open [`http://localhost:3000`](http://localhost:3000) and follow the tutorial. :::tip diff --git a/website/versioned_docs/version-3.0.0-alpha.0/migration/migration-manual.mdx b/website/versioned_docs/version-3.0.0-alpha.0/migration/migration-manual.mdx index 49a7cdd1fce4..a44c4ac8ca17 100644 --- a/website/versioned_docs/version-3.0.0-alpha.0/migration/migration-manual.mdx +++ b/website/versioned_docs/version-3.0.0-alpha.0/migration/migration-manual.mdx @@ -441,8 +441,8 @@ In v1, all pages were available with or without the `.html` extension. For example, these 2 pages exist: -- [https://v1.docusaurus.io/docs/en/installation](https://v1.docusaurus.io/docs/en/installation) -- [https://v1.docusaurus.io/docs/en/installation.html](https://v1.docusaurus.io/docs/en/installation.html) +- [`https://v1.docusaurus.io/docs/en/installation`](https://v1.docusaurus.io/docs/en/installation) +- [`https://v1.docusaurus.io/docs/en/installation.html`](https://v1.docusaurus.io/docs/en/installation.html) If [`cleanUrl`](https://v1.docusaurus.io/docs/en/site-config#cleanurl-boolean) was: