mirror of
https://github.com/facebook/docusaurus.git
synced 2025-08-03 16:59:06 +02:00
docs: fix some casing inconsistencies (#7081)
This commit is contained in:
Joshua Chen
GitHub
parent
24c205a835
commit
ff96606865
45 changed files with 97 additions and 97 deletions
|
|
@ -87,7 +87,7 @@ This feature has not been an easy one, and we would like to thank everyone that
|
|||
- [Claire](https://github.com/clairefro) for adopting Docusaurus 2 on the new Redwood platform and providing many feedbacks
|
||||
- [Massoud](https://github.com/massoudmaboudi) for reviewing my work on LTR and adopting it on Datagit
|
||||
- [Crowdin](https://crowdin.com/) for their support and willingness to improve their translation SaaS
|
||||
- The Docusaurus community for their patience, and providing many useful feedbacks on Github
|
||||
- The Docusaurus community for their patience, and providing many useful feedbacks on GitHub
|
||||
|
||||
Thanks for reading.
|
||||
|
||||
|
|
|
|||
|
|
@ -34,11 +34,11 @@ Our codebase has been polished over time as well. We have improved test coverage
|
|||
|
||||
## Trends
|
||||
|
||||
### NPM
|
||||
### npm
|
||||
|
||||
Docusaurus v2 continues to grow steadily. V2 installation is now 8 times more than v1. In terms of weekly downloads, we have witnessed another three-fold increase (+209.4%), growing from 28,066 in early January to a peak of 86,846 in mid-December.
|
||||
|
||||
[](https://www.npmtrends.com/docusaurus-vs-@docusaurus/core)
|
||||
[](https://www.npmtrends.com/docusaurus-vs-@docusaurus/core)
|
||||
|
||||
(Ah, the classic Christmas dip...)
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ module.exports = {
|
|||
|
||||
### Module definition {#module-definition}
|
||||
|
||||
You can use a plugin as a module path referencing a separate file or NPM package:
|
||||
You can use a plugin as a module path referencing a separate file or npm package:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -522,7 +522,7 @@ jobs:
|
|||
|
||||
### Triggering deployment with Travis CI {#triggering-deployment-with-travis-ci}
|
||||
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
|
||||
1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs.
|
||||
2. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate.
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ This is merely a recommended directory structure, and you will still need to man
|
|||
|
||||
:::
|
||||
|
||||
By default, any Markdown or Javascript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
By default, any Markdown or JavaScript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
|
||||
```bash
|
||||
my-website
|
||||
|
|
|
|||
|
|
@ -534,7 +534,7 @@ If you have multiple of these multi-language code tabs, and you want to sync the
|
|||
|
||||
### Docusaurus npm2yarn remark plugin {#npm2yarn-remark-plugin}
|
||||
|
||||
Displaying CLI commands in both NPM and Yarn is a very common need, for example:
|
||||
Displaying CLI commands in both npm and Yarn is a very common need, for example:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @docusaurus/remark-plugin-npm2yarn
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ The writeup below is **not** meant to be a comprehensive guide to creating a plu
|
|||
|
||||
:::
|
||||
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate NPM package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate npm package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
|
||||
```js "src/remark/section-prefix.js"
|
||||
const visit = require('unist-util-visit');
|
||||
|
|
|
|||
|
|
@ -142,13 +142,13 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
|
|
@ -156,12 +156,12 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
<br/>
|
||||
|
|
@ -174,7 +174,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<TabItem value="win" label="Windows">
|
||||
I am Windows.
|
||||
</TabItem>
|
||||
<TabItem value="mac" label="MacOS">
|
||||
<TabItem value="mac" label="macOS">
|
||||
I am macOS.
|
||||
</TabItem>
|
||||
<TabItem value="linux" label="Linux">
|
||||
|
|
@ -187,7 +187,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">I am Windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">I am macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">I am macOS.</TabItem>
|
||||
<TabItem value="linux" label="Linux">I am Linux.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
|
|
@ -201,7 +201,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
|
|
@ -215,7 +215,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="non-mac-operating-systems">
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ You should **not commit** it, and it may be a good idea to create a dedicated **
|
|||
|
||||
This tutorial uses the CLI version `3.5.2`, but we expect `3.x` releases to keep working.
|
||||
|
||||
Install the Crowdin CLI as an NPM package to your Docusaurus site:
|
||||
Install the Crowdin CLI as an npm package to your Docusaurus site:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @crowdin/cli@3
|
||||
|
|
@ -468,7 +468,7 @@ module.exports = {
|
|||
if (locale !== DefaultLocale) {
|
||||
return `https://crowdin.com/project/docusaurus-v2/${locale}`;
|
||||
}
|
||||
// Link to Github for English docs
|
||||
// Link to GitHub for English docs
|
||||
return `https://github.com/facebook/docusaurus/edit/main/website/${versionDocsDirPath}/${docPath}`;
|
||||
},
|
||||
// highlight-end
|
||||
|
|
|
|||
|
|
@ -437,7 +437,7 @@ On your [static hosting provider](../deployment.mdx):
|
|||
|
||||
:::caution
|
||||
|
||||
This strategy is **not possible** with Github Pages, as it is only possible to **have a single deployment**.
|
||||
This strategy is **not possible** with GitHub Pages, as it is only possible to **have a single deployment**.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Docusaurus is written in TypeScript and provides first-class TypeScript support.
|
|||
|
||||
## Initialization {#initialization}
|
||||
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
|
||||
```bash
|
||||
npx create-docusaurus@latest my-website classic --typescript
|
||||
|
|
@ -104,7 +104,7 @@ module.exports = config;
|
|||
|
||||
Type annotations are very useful and help your IDE understand the type of config objects!
|
||||
|
||||
The best IDEs (VSCode, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
The best IDEs (VS Code, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -30,7 +30,7 @@ import {sortBy} from '@site/src/utils/jsUtils';
|
|||
*
|
||||
* Example PR: https://github.com/facebook/docusaurus/pull/3976
|
||||
*
|
||||
* If you edit this file through the Github interface, you can:
|
||||
* If you edit this file through the GitHub interface, you can:
|
||||
* - Submit first your users.tsx edit PR
|
||||
* - This will create a branch on your Docusaurus fork (usually "patch-1")
|
||||
* - Go to https://github.com/<username>/docusaurus/tree/<branch>/website/src/data/showcase
|
||||
|
|
@ -281,7 +281,7 @@ const Users: User[] = [
|
|||
{
|
||||
title: 'Blog Matheus Brunelli',
|
||||
description:
|
||||
'Desenvolvimento de software, carreira, dicas de livros e muito Javascript!',
|
||||
'Desenvolvimento de software, carreira, dicas de livros e muito JavaScript!',
|
||||
preview: require('./showcase/blogmatheusbrunelli.png'),
|
||||
website: 'https://mrbrunelli.github.io/blog/',
|
||||
source: 'https://github.com/mrbrunelli/blog',
|
||||
|
|
@ -624,7 +624,7 @@ const Users: User[] = [
|
|||
},
|
||||
{
|
||||
title: 'FirelordJS',
|
||||
description: 'Typescript Wrapper for Firestore',
|
||||
description: 'TypeScript Wrapper for Firestore',
|
||||
preview: require('./showcase/firelordjs.png'),
|
||||
website: 'https://firelordjs.com',
|
||||
source: 'https://github.com/tylim88/FirelordJSDoc',
|
||||
|
|
@ -1008,7 +1008,7 @@ const Users: User[] = [
|
|||
{
|
||||
title: 'Molecule',
|
||||
description:
|
||||
'Molecule is a lightweight Web IDE UI framework built with React.js and inspired by VSCode.',
|
||||
'Molecule is a lightweight Web IDE UI framework built with React.js and inspired by VS Code.',
|
||||
preview: require('./showcase/molecule-home.png'),
|
||||
website: 'https://dtstack.github.io/molecule/',
|
||||
source: 'https://github.com/DTStack/molecule/tree/main/website',
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ module.exports = {
|
|||
|
||||
### Module definition {#module-definition}
|
||||
|
||||
You can use a plugin as a module path referencing a separate file or NPM package:
|
||||
You can use a plugin as a module path referencing a separate file or npm package:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -522,7 +522,7 @@ jobs:
|
|||
|
||||
### Triggering deployment with Travis CI {#triggering-deployment-with-travis-ci}
|
||||
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
|
||||
1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs.
|
||||
2. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate.
|
||||
|
|
|
|||
|
|
@ -117,7 +117,7 @@ This is merely a recommended directory structure, and you will still need to man
|
|||
|
||||
:::
|
||||
|
||||
By default, any Markdown or Javascript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
By default, any Markdown or JavaScript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
|
||||
```bash
|
||||
my-website
|
||||
|
|
|
|||
|
|
@ -526,7 +526,7 @@ If you have multiple of these multi-language code tabs, and you want to sync the
|
|||
|
||||
### Docusaurus npm2yarn remark plugin {#npm2yarn-remark-plugin}
|
||||
|
||||
Displaying CLI commands in both NPM and Yarn is a very common need, for example:
|
||||
Displaying CLI commands in both npm and Yarn is a very common need, for example:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @docusaurus/remark-plugin-npm2yarn
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ The writeup below is **not** meant to be a comprehensive guide to creating a plu
|
|||
|
||||
:::
|
||||
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate NPM package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate npm package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
|
||||
```js "src/remark/section-prefix.js"
|
||||
const visit = require('unist-util-visit');
|
||||
|
|
|
|||
|
|
@ -142,13 +142,13 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
|
|
@ -156,12 +156,12 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
<br/>
|
||||
|
|
@ -174,7 +174,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<TabItem value="win" label="Windows">
|
||||
I am Windows.
|
||||
</TabItem>
|
||||
<TabItem value="mac" label="MacOS">
|
||||
<TabItem value="mac" label="macOS">
|
||||
I am macOS.
|
||||
</TabItem>
|
||||
<TabItem value="linux" label="Linux">
|
||||
|
|
@ -187,7 +187,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">I am Windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">I am macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">I am macOS.</TabItem>
|
||||
<TabItem value="linux" label="Linux">I am Linux.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
|
|
@ -201,7 +201,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
|
|
@ -215,7 +215,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="non-mac-operating-systems">
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ You should **not commit** it, and it may be a good idea to create a dedicated **
|
|||
|
||||
This tutorial uses the CLI version `3.5.2`, but we expect `3.x` releases to keep working.
|
||||
|
||||
Install the Crowdin CLI as an NPM package to your Docusaurus site:
|
||||
Install the Crowdin CLI as an npm package to your Docusaurus site:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @crowdin/cli@3
|
||||
|
|
@ -468,7 +468,7 @@ module.exports = {
|
|||
if (locale !== DefaultLocale) {
|
||||
return `https://crowdin.com/project/docusaurus-v2/${locale}`;
|
||||
}
|
||||
// Link to Github for English docs
|
||||
// Link to GitHub for English docs
|
||||
return `https://github.com/facebook/docusaurus/edit/main/website/${versionDocsDirPath}/${docPath}`;
|
||||
},
|
||||
// highlight-end
|
||||
|
|
|
|||
|
|
@ -437,7 +437,7 @@ On your [static hosting provider](../deployment.mdx):
|
|||
|
||||
:::caution
|
||||
|
||||
This strategy is **not possible** with Github Pages, as it is only possible to **have a single deployment**.
|
||||
This strategy is **not possible** with GitHub Pages, as it is only possible to **have a single deployment**.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Docusaurus is written in TypeScript and provides first-class TypeScript support.
|
|||
|
||||
## Initialization {#initialization}
|
||||
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
|
||||
```bash
|
||||
npx create-docusaurus@latest my-website classic --typescript
|
||||
|
|
@ -104,7 +104,7 @@ module.exports = config;
|
|||
|
||||
Type annotations are very useful and help your IDE understand the type of config objects!
|
||||
|
||||
The best IDEs (VSCode, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
The best IDEs (VS Code, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -35,7 +35,7 @@ module.exports = {
|
|||
|
||||
### Module definition {#module-definition}
|
||||
|
||||
You can use a plugin as a module path referencing a separate file or NPM package:
|
||||
You can use a plugin as a module path referencing a separate file or npm package:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
module.exports = {
|
||||
|
|
|
|||
|
|
@ -522,7 +522,7 @@ jobs:
|
|||
|
||||
### Triggering deployment with Travis CI {#triggering-deployment-with-travis-ci}
|
||||
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to NPM, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
Continuous integration (CI) services are typically used to perform routine tasks whenever new commits are checked in to source control. These tasks can be any combination of running unit tests and integration tests, automating builds, publishing packages to npm, and deploying changes to your website. All you need to do to automate the deployment of your website is to invoke the `yarn deploy` script whenever your website is updated. The following section covers how to do just that using [Travis CI](https://travis-ci.com/), a popular continuous integration service provider.
|
||||
|
||||
1. Go to https://github.com/settings/tokens and generate a new [personal access token](https://help.github.com/articles/creating-a-personal-access-token-for-the-command-line/). When creating the token, grant it the `repo` scope so that it has the permissions it needs.
|
||||
2. Using your GitHub account, [add the Travis CI app](https://github.com/marketplace/travis-ci) to the repository you want to activate.
|
||||
|
|
|
|||
|
|
@ -115,7 +115,7 @@ This is merely a recommended directory structure, and you will still need to man
|
|||
|
||||
:::
|
||||
|
||||
By default, any Markdown or Javascript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
By default, any Markdown or JavaScript file starting with `_` will be ignored and no routes will be created for that file (see the `exclude` option).
|
||||
|
||||
```bash
|
||||
my-website
|
||||
|
|
|
|||
|
|
@ -534,7 +534,7 @@ If you have multiple of these multi-language code tabs, and you want to sync the
|
|||
|
||||
### Docusaurus npm2yarn remark plugin {#npm2yarn-remark-plugin}
|
||||
|
||||
Displaying CLI commands in both NPM and Yarn is a very common need, for example:
|
||||
Displaying CLI commands in both npm and Yarn is a very common need, for example:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @docusaurus/remark-plugin-npm2yarn
|
||||
|
|
|
|||
|
|
@ -124,7 +124,7 @@ The writeup below is **not** meant to be a comprehensive guide to creating a plu
|
|||
|
||||
:::
|
||||
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate NPM package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
For example, let's make a plugin that visits every `h2` heading and adds a `Section X. ` prefix. First, create your plugin source file anywhere—you can even publish it as a separate npm package and install it like explained above. We would put ours at `src/remark/section-prefix.js`. A remark/rehype plugin is just a function that receives the `options` and returns a `transformer` that operates on the AST.
|
||||
|
||||
```js "src/remark/section-prefix.js"
|
||||
const visit = require('unist-util-visit');
|
||||
|
|
|
|||
|
|
@ -142,13 +142,13 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
```
|
||||
|
||||
|
|
@ -156,12 +156,12 @@ You may want choices of the same kind of tabs to sync with each other. For examp
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + C to copy.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + C to copy.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Use Ctrl + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">Use Command + V to paste.</TabItem>
|
||||
<TabItem value="mac" label="macOS">Use Command + V to paste.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
<br/>
|
||||
|
|
@ -174,7 +174,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<TabItem value="win" label="Windows">
|
||||
I am Windows.
|
||||
</TabItem>
|
||||
<TabItem value="mac" label="MacOS">
|
||||
<TabItem value="mac" label="macOS">
|
||||
I am macOS.
|
||||
</TabItem>
|
||||
<TabItem value="linux" label="Linux">
|
||||
|
|
@ -187,7 +187,7 @@ For all tab groups that have the same `groupId`, the possible values do not need
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">I am Windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">I am macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">I am macOS.</TabItem>
|
||||
<TabItem value="linux" label="Linux">I am Linux.</TabItem>
|
||||
</Tabs>
|
||||
</BrowserWindow>
|
||||
|
|
@ -201,7 +201,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
// highlight-next-line
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
// highlight-next-line
|
||||
|
|
@ -215,7 +215,7 @@ Tab choices with different group IDs will not interfere with each other:
|
|||
<BrowserWindow>
|
||||
<Tabs groupId="operating-systems">
|
||||
<TabItem value="win" label="Windows">Windows in windows.</TabItem>
|
||||
<TabItem value="mac" label="MacOS">macOS is macOS.</TabItem>
|
||||
<TabItem value="mac" label="macOS">macOS is macOS.</TabItem>
|
||||
</Tabs>
|
||||
|
||||
<Tabs groupId="non-mac-operating-systems">
|
||||
|
|
|
|||
|
|
@ -182,7 +182,7 @@ You should **not commit** it, and it may be a good idea to create a dedicated **
|
|||
|
||||
This tutorial uses the CLI version `3.5.2`, but we expect `3.x` releases to keep working.
|
||||
|
||||
Install the Crowdin CLI as an NPM package to your Docusaurus site:
|
||||
Install the Crowdin CLI as an npm package to your Docusaurus site:
|
||||
|
||||
```bash npm2yarn
|
||||
npm install @crowdin/cli@3
|
||||
|
|
@ -468,7 +468,7 @@ module.exports = {
|
|||
if (locale !== DefaultLocale) {
|
||||
return `https://crowdin.com/project/docusaurus-v2/${locale}`;
|
||||
}
|
||||
// Link to Github for English docs
|
||||
// Link to GitHub for English docs
|
||||
return `https://github.com/facebook/docusaurus/edit/main/website/${versionDocsDirPath}/${docPath}`;
|
||||
},
|
||||
// highlight-end
|
||||
|
|
|
|||
|
|
@ -437,7 +437,7 @@ On your [static hosting provider](../deployment.mdx):
|
|||
|
||||
:::caution
|
||||
|
||||
This strategy is **not possible** with Github Pages, as it is only possible to **have a single deployment**.
|
||||
This strategy is **not possible** with GitHub Pages, as it is only possible to **have a single deployment**.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@ Docusaurus is written in TypeScript and provides first-class TypeScript support.
|
|||
|
||||
## Initialization {#initialization}
|
||||
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a Typescript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
Docusaurus supports writing and using TypeScript theme components. If the init template provides a TypeScript variant, you can directly initialize a site with full TypeScript support by using the `--typescript` flag.
|
||||
|
||||
```bash
|
||||
npx create-docusaurus@latest my-website classic --typescript
|
||||
|
|
@ -104,7 +104,7 @@ module.exports = config;
|
|||
|
||||
Type annotations are very useful and help your IDE understand the type of config objects!
|
||||
|
||||
The best IDEs (VSCode, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
The best IDEs (VS Code, WebStorm, IntelliJ...) will provide a nice auto-completion experience.
|
||||
|
||||
:::
|
||||
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue