mirror of
https://github.com/facebook/docusaurus.git
synced 2025-06-07 13:22:26 +02:00
docs(v2): deployment should use mdx extension (#3699)
* deployment: make it a mdx component because it contains <Tabs> * fix deployment md links * typo * fix more links
This commit is contained in:
parent
8753fc74c3
commit
c22c132fe0
20 changed files with 55 additions and 20 deletions
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -93,7 +93,14 @@ Optional parameters, also set as environment variables:
|
|||
|
||||
Finally, to deploy your site to GitHub Pages, run:
|
||||
|
||||
<Tabs defaultValue="bash" values={[ { label: 'Bash', value: 'bash', }, { label: 'Windows', value: 'windows', }, { label: 'PowerShell', value: 'powershell', },]}><TabItem value="bash">
|
||||
<Tabs
|
||||
defaultValue="bash"
|
||||
values={[
|
||||
{ label: 'Bash', value: 'bash' },
|
||||
{ label: 'Windows', value: 'windows' },
|
||||
{ label: 'PowerShell', value: 'powershell' }
|
||||
]}>
|
||||
<TabItem value="bash">
|
||||
|
||||
```bash
|
||||
GIT_USER=<GITHUB_USERNAME> yarn deploy
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -93,7 +93,14 @@ Optional parameters, also set as environment variables:
|
|||
|
||||
Finally, to deploy your site to GitHub Pages, run:
|
||||
|
||||
<Tabs defaultValue="bash" values={[ { label: 'Bash', value: 'bash', }, { label: 'Windows', value: 'windows', }, { label: 'PowerShell', value: 'powershell', },]}><TabItem value="bash">
|
||||
<Tabs
|
||||
defaultValue="bash"
|
||||
values={[
|
||||
{ label: 'Bash', value: 'bash' },
|
||||
{ label: 'Windows', value: 'windows' },
|
||||
{ label: 'PowerShell', value: 'powershell' }
|
||||
]}>
|
||||
<TabItem value="bash">
|
||||
|
||||
```bash
|
||||
GIT_USER=<GITHUB_USERNAME> yarn deploy
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -93,7 +93,14 @@ Optional parameters, also set as environment variables:
|
|||
|
||||
Finally, to deploy your site to GitHub Pages, run:
|
||||
|
||||
<Tabs defaultValue="bash" values={[ { label: 'Bash', value: 'bash', }, { label: 'Windows', value: 'windows', }, { label: 'PowerShell', value: 'powershell', },]}><TabItem value="bash">
|
||||
<Tabs
|
||||
defaultValue="bash"
|
||||
values={[
|
||||
{ label: 'Bash', value: 'bash' },
|
||||
{ label: 'Windows', value: 'windows' },
|
||||
{ label: 'PowerShell', value: 'powershell' }
|
||||
]}>
|
||||
<TabItem value="bash">
|
||||
|
||||
```bash
|
||||
GIT_USER=<GITHUB_USERNAME> yarn deploy
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -93,7 +93,14 @@ Optional parameters, also set as environment variables:
|
|||
|
||||
Finally, to deploy your site to GitHub Pages, run:
|
||||
|
||||
<Tabs defaultValue="bash" values={[ { label: 'Bash', value: 'bash', }, { label: 'Windows', value: 'windows', }, { label: 'PowerShell', value: 'powershell', },]}><TabItem value="bash">
|
||||
<Tabs
|
||||
defaultValue="bash"
|
||||
values={[
|
||||
{ label: 'Bash', value: 'bash' },
|
||||
{ label: 'Windows', value: 'windows' },
|
||||
{ label: 'PowerShell', value: 'powershell' }
|
||||
]}>
|
||||
<TabItem value="bash">
|
||||
|
||||
```bash
|
||||
GIT_USER=<GITHUB_USERNAME> yarn deploy
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -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
|
||||
|
||||
|
|
|
@ -93,7 +93,14 @@ Optional parameters, also set as environment variables:
|
|||
|
||||
Finally, to deploy your site to GitHub Pages, run:
|
||||
|
||||
<Tabs defaultValue="bash" values={[ { label: 'Bash', value: 'bash', }, { label: 'Windows', value: 'windows', }, { label: 'PowerShell', value: 'powershell', },]}><TabItem value="bash">
|
||||
<Tabs
|
||||
defaultValue="bash"
|
||||
values={[
|
||||
{ label: 'Bash', value: 'bash' },
|
||||
{ label: 'Windows', value: 'windows' },
|
||||
{ label: 'PowerShell', value: 'powershell' }
|
||||
]}>
|
||||
<TabItem value="bash">
|
||||
|
||||
```bash
|
||||
GIT_USER=<GITHUB_USERNAME> yarn deploy
|
|
@ -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
|
||||
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue