From c22c132fe0e9b565b9b4015dac6f554e2186b463 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?S=C3=A9bastien=20Lorber?= Date: Thu, 5 Nov 2020 18:22:18 +0100 Subject: [PATCH] docs(v2): deployment should use mdx extension (#3699) * deployment: make it a mdx component because it contains * fix deployment md links * typo * fix more links --- website/docs/cli.md | 2 +- website/docs/configuration.md | 2 +- website/docs/{deployment.md => deployment.mdx} | 9 ++++++++- website/docs/installation.md | 2 +- website/versioned_docs/version-2.0.0-alpha.63/cli.md | 2 +- .../version-2.0.0-alpha.63/configuration.md | 2 +- .../{deployment.md => deployment.mdx} | 9 ++++++++- .../version-2.0.0-alpha.63/installation.md | 2 +- website/versioned_docs/version-2.0.0-alpha.64/cli.md | 2 +- .../version-2.0.0-alpha.64/configuration.md | 2 +- .../{deployment.md => deployment.mdx} | 9 ++++++++- .../version-2.0.0-alpha.64/installation.md | 2 +- website/versioned_docs/version-2.0.0-alpha.65/cli.md | 2 +- .../version-2.0.0-alpha.65/configuration.md | 2 +- .../{deployment.md => deployment.mdx} | 9 ++++++++- .../version-2.0.0-alpha.65/installation.md | 2 +- website/versioned_docs/version-2.0.0-alpha.66/cli.md | 2 +- .../version-2.0.0-alpha.66/configuration.md | 2 +- .../{deployment.md => deployment.mdx} | 9 ++++++++- .../version-2.0.0-alpha.66/installation.md | 2 +- 20 files changed, 55 insertions(+), 20 deletions(-) rename website/docs/{deployment.md => deployment.mdx} (98%) rename website/versioned_docs/version-2.0.0-alpha.63/{deployment.md => deployment.mdx} (98%) rename website/versioned_docs/version-2.0.0-alpha.64/{deployment.md => deployment.mdx} (98%) rename website/versioned_docs/version-2.0.0-alpha.65/{deployment.md => deployment.mdx} (98%) rename website/versioned_docs/version-2.0.0-alpha.66/{deployment.md => deployment.mdx} (98%) diff --git a/website/docs/cli.md b/website/docs/cli.md index f649f7309a..8dcd27ee2b 100644 --- a/website/docs/cli.md +++ b/website/docs/cli.md @@ -124,7 +124,7 @@ To learn more about swizzling, check [here](#). ### `docusaurus deploy` -Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.md/#deploying-to-github-pages) for more details. +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. #### Options diff --git a/website/docs/configuration.md b/website/docs/configuration.md index bc4aa54864..4bf77438b4 100644 --- a/website/docs/configuration.md +++ b/website/docs/configuration.md @@ -34,7 +34,7 @@ They are used in a number of places such as your site's title and headings, brow Deployment configurations such as `projectName` and `organizationName` are used when you deploy your site with the `deploy` command. -It is recommended to check the [deployment docs](deployment.md) for more information. +It is recommended to check the [deployment docs](deployment.mdx)) for more information. ### Theme, plugin, and preset configurations diff --git a/website/docs/deployment.md b/website/docs/deployment.mdx similarity index 98% rename from website/docs/deployment.md rename to website/docs/deployment.mdx index 3c9bd9d99a..5eed54ce81 100644 --- a/website/docs/deployment.md +++ b/website/docs/deployment.mdx @@ -93,7 +93,14 @@ Optional parameters, also set as environment variables: Finally, to deploy your site to GitHub Pages, run: - + + ```bash GIT_USER= yarn deploy diff --git a/website/docs/installation.md b/website/docs/installation.md index 8e45c696ca..bedbf2d122 100644 --- a/website/docs/installation.md +++ b/website/docs/installation.md @@ -100,7 +100,7 @@ Docusaurus is a modern static website generator so we need to build the website npm run build ``` -and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.mdx)) for more details. ## Updating your Docusaurus version diff --git a/website/versioned_docs/version-2.0.0-alpha.63/cli.md b/website/versioned_docs/version-2.0.0-alpha.63/cli.md index 88c765a8ff..fbf1bab104 100644 --- a/website/versioned_docs/version-2.0.0-alpha.63/cli.md +++ b/website/versioned_docs/version-2.0.0-alpha.63/cli.md @@ -107,7 +107,7 @@ To learn more about swizzling, check [here](#). ### `docusaurus deploy` -Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.md/#deploying-to-github-pages) for more details. +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. #### Options diff --git a/website/versioned_docs/version-2.0.0-alpha.63/configuration.md b/website/versioned_docs/version-2.0.0-alpha.63/configuration.md index c84a39b050..fe87e9479a 100644 --- a/website/versioned_docs/version-2.0.0-alpha.63/configuration.md +++ b/website/versioned_docs/version-2.0.0-alpha.63/configuration.md @@ -34,7 +34,7 @@ They are used in a number of places such as your site's title and headings, brow Deployment configurations such as `projectName` and `organizationName` are used when you deploy your site with the `deploy` command. -It is recommended to check the [deployment docs](deployment.md) for more information. +It is recommended to check the [deployment docs](deployment.mdx)) for more information. ### Theme, plugin, and preset configurations diff --git a/website/versioned_docs/version-2.0.0-alpha.63/deployment.md b/website/versioned_docs/version-2.0.0-alpha.63/deployment.mdx similarity index 98% rename from website/versioned_docs/version-2.0.0-alpha.63/deployment.md rename to website/versioned_docs/version-2.0.0-alpha.63/deployment.mdx index 8d52a94c2e..698b5afc06 100644 --- a/website/versioned_docs/version-2.0.0-alpha.63/deployment.md +++ b/website/versioned_docs/version-2.0.0-alpha.63/deployment.mdx @@ -93,7 +93,14 @@ Optional parameters, also set as environment variables: Finally, to deploy your site to GitHub Pages, run: - + + ```bash GIT_USER= yarn deploy diff --git a/website/versioned_docs/version-2.0.0-alpha.63/installation.md b/website/versioned_docs/version-2.0.0-alpha.63/installation.md index 8e45c696ca..bedbf2d122 100644 --- a/website/versioned_docs/version-2.0.0-alpha.63/installation.md +++ b/website/versioned_docs/version-2.0.0-alpha.63/installation.md @@ -100,7 +100,7 @@ Docusaurus is a modern static website generator so we need to build the website npm run build ``` -and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.mdx)) for more details. ## Updating your Docusaurus version diff --git a/website/versioned_docs/version-2.0.0-alpha.64/cli.md b/website/versioned_docs/version-2.0.0-alpha.64/cli.md index 88c765a8ff..fbf1bab104 100644 --- a/website/versioned_docs/version-2.0.0-alpha.64/cli.md +++ b/website/versioned_docs/version-2.0.0-alpha.64/cli.md @@ -107,7 +107,7 @@ To learn more about swizzling, check [here](#). ### `docusaurus deploy` -Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.md/#deploying-to-github-pages) for more details. +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. #### Options diff --git a/website/versioned_docs/version-2.0.0-alpha.64/configuration.md b/website/versioned_docs/version-2.0.0-alpha.64/configuration.md index c84a39b050..fe87e9479a 100644 --- a/website/versioned_docs/version-2.0.0-alpha.64/configuration.md +++ b/website/versioned_docs/version-2.0.0-alpha.64/configuration.md @@ -34,7 +34,7 @@ They are used in a number of places such as your site's title and headings, brow Deployment configurations such as `projectName` and `organizationName` are used when you deploy your site with the `deploy` command. -It is recommended to check the [deployment docs](deployment.md) for more information. +It is recommended to check the [deployment docs](deployment.mdx)) for more information. ### Theme, plugin, and preset configurations diff --git a/website/versioned_docs/version-2.0.0-alpha.64/deployment.md b/website/versioned_docs/version-2.0.0-alpha.64/deployment.mdx similarity index 98% rename from website/versioned_docs/version-2.0.0-alpha.64/deployment.md rename to website/versioned_docs/version-2.0.0-alpha.64/deployment.mdx index 8d52a94c2e..698b5afc06 100644 --- a/website/versioned_docs/version-2.0.0-alpha.64/deployment.md +++ b/website/versioned_docs/version-2.0.0-alpha.64/deployment.mdx @@ -93,7 +93,14 @@ Optional parameters, also set as environment variables: Finally, to deploy your site to GitHub Pages, run: - + + ```bash GIT_USER= yarn deploy diff --git a/website/versioned_docs/version-2.0.0-alpha.64/installation.md b/website/versioned_docs/version-2.0.0-alpha.64/installation.md index 8e45c696ca..bedbf2d122 100644 --- a/website/versioned_docs/version-2.0.0-alpha.64/installation.md +++ b/website/versioned_docs/version-2.0.0-alpha.64/installation.md @@ -100,7 +100,7 @@ Docusaurus is a modern static website generator so we need to build the website npm run build ``` -and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.mdx)) for more details. ## Updating your Docusaurus version diff --git a/website/versioned_docs/version-2.0.0-alpha.65/cli.md b/website/versioned_docs/version-2.0.0-alpha.65/cli.md index 3357e8739d..6a434dda8e 100644 --- a/website/versioned_docs/version-2.0.0-alpha.65/cli.md +++ b/website/versioned_docs/version-2.0.0-alpha.65/cli.md @@ -108,7 +108,7 @@ To learn more about swizzling, check [here](#). ### `docusaurus deploy` -Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.md/#deploying-to-github-pages) for more details. +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. #### Options diff --git a/website/versioned_docs/version-2.0.0-alpha.65/configuration.md b/website/versioned_docs/version-2.0.0-alpha.65/configuration.md index bc4aa54864..4bf77438b4 100644 --- a/website/versioned_docs/version-2.0.0-alpha.65/configuration.md +++ b/website/versioned_docs/version-2.0.0-alpha.65/configuration.md @@ -34,7 +34,7 @@ They are used in a number of places such as your site's title and headings, brow Deployment configurations such as `projectName` and `organizationName` are used when you deploy your site with the `deploy` command. -It is recommended to check the [deployment docs](deployment.md) for more information. +It is recommended to check the [deployment docs](deployment.mdx)) for more information. ### Theme, plugin, and preset configurations diff --git a/website/versioned_docs/version-2.0.0-alpha.65/deployment.md b/website/versioned_docs/version-2.0.0-alpha.65/deployment.mdx similarity index 98% rename from website/versioned_docs/version-2.0.0-alpha.65/deployment.md rename to website/versioned_docs/version-2.0.0-alpha.65/deployment.mdx index 120f7fd791..3b6981e108 100644 --- a/website/versioned_docs/version-2.0.0-alpha.65/deployment.md +++ b/website/versioned_docs/version-2.0.0-alpha.65/deployment.mdx @@ -93,7 +93,14 @@ Optional parameters, also set as environment variables: Finally, to deploy your site to GitHub Pages, run: - + + ```bash GIT_USER= yarn deploy diff --git a/website/versioned_docs/version-2.0.0-alpha.65/installation.md b/website/versioned_docs/version-2.0.0-alpha.65/installation.md index 8e45c696ca..bedbf2d122 100644 --- a/website/versioned_docs/version-2.0.0-alpha.65/installation.md +++ b/website/versioned_docs/version-2.0.0-alpha.65/installation.md @@ -100,7 +100,7 @@ Docusaurus is a modern static website generator so we need to build the website npm run build ``` -and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.mdx)) for more details. ## Updating your Docusaurus version diff --git a/website/versioned_docs/version-2.0.0-alpha.66/cli.md b/website/versioned_docs/version-2.0.0-alpha.66/cli.md index 3357e8739d..6a434dda8e 100644 --- a/website/versioned_docs/version-2.0.0-alpha.66/cli.md +++ b/website/versioned_docs/version-2.0.0-alpha.66/cli.md @@ -108,7 +108,7 @@ To learn more about swizzling, check [here](#). ### `docusaurus deploy` -Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.md/#deploying-to-github-pages) for more details. +Deploys your site with [GitHub Pages](https://pages.github.com/). Check out the docs on [deployment](deployment.mdx#deploying-to-github-pages) for more details. #### Options diff --git a/website/versioned_docs/version-2.0.0-alpha.66/configuration.md b/website/versioned_docs/version-2.0.0-alpha.66/configuration.md index bc4aa54864..4bf77438b4 100644 --- a/website/versioned_docs/version-2.0.0-alpha.66/configuration.md +++ b/website/versioned_docs/version-2.0.0-alpha.66/configuration.md @@ -34,7 +34,7 @@ They are used in a number of places such as your site's title and headings, brow Deployment configurations such as `projectName` and `organizationName` are used when you deploy your site with the `deploy` command. -It is recommended to check the [deployment docs](deployment.md) for more information. +It is recommended to check the [deployment docs](deployment.mdx)) for more information. ### Theme, plugin, and preset configurations diff --git a/website/versioned_docs/version-2.0.0-alpha.66/deployment.md b/website/versioned_docs/version-2.0.0-alpha.66/deployment.mdx similarity index 98% rename from website/versioned_docs/version-2.0.0-alpha.66/deployment.md rename to website/versioned_docs/version-2.0.0-alpha.66/deployment.mdx index 3c9bd9d99a..5eed54ce81 100644 --- a/website/versioned_docs/version-2.0.0-alpha.66/deployment.md +++ b/website/versioned_docs/version-2.0.0-alpha.66/deployment.mdx @@ -93,7 +93,14 @@ Optional parameters, also set as environment variables: Finally, to deploy your site to GitHub Pages, run: - + + ```bash GIT_USER= yarn deploy diff --git a/website/versioned_docs/version-2.0.0-alpha.66/installation.md b/website/versioned_docs/version-2.0.0-alpha.66/installation.md index 8e45c696ca..bedbf2d122 100644 --- a/website/versioned_docs/version-2.0.0-alpha.66/installation.md +++ b/website/versioned_docs/version-2.0.0-alpha.66/installation.md @@ -100,7 +100,7 @@ Docusaurus is a modern static website generator so we need to build the website npm run build ``` -and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.md) for more details. +and contents will be generated within the `/build` directory, which can be copied to any static file hosting service like [GitHub pages](https://pages.github.com/), [Now](https://zeit.co/now) or [Netlify](https://www.netlify.com/). Check out the docs on [deployment](deployment.mdx)) for more details. ## Updating your Docusaurus version