docs: updated README to contain npm npx and not yarn
This commit is contained in:
parent
e09ac2c755
commit
e327745350
@ -5,11 +5,34 @@ and GitHub Actions (see [deploy-docs.yml](../.github/workflows/deploy-docs.yml))
|
|||||||
|
|
||||||
## Local Development
|
## Local Development
|
||||||
|
|
||||||
To test build the docs locally you can either use `yarn` or `npm`.
|
To test build the docs locally use:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ npm ci # install docusaurus and dependencies (based on the package-lock.json file)
|
||||||
|
$ npx docusaurus start # start local dev server
|
||||||
|
```
|
||||||
|
|
||||||
|
By default `docusaurus.config.js` contains instructions for the building of a few extra branches. You may want to drop all but the current branch. For example:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ yarn install # install docusaurus and dependencies
|
diff --git a/docs/docusaurus.config.js b/docs/docusaurus.config.js
|
||||||
$ yarn start # start local dev server
|
index 50b72b12ec..04f360a955 100644
|
||||||
|
--- a/docs/docusaurus.config.js
|
||||||
|
+++ b/docs/docusaurus.config.js
|
||||||
|
@@ -38,12 +38,6 @@ const config = {
|
||||||
|
lastVersion: '2.7',
|
||||||
|
includeCurrentVersion: false,
|
||||||
|
versions: {
|
||||||
|
- '2.5-legacy': {
|
||||||
|
- banner: 'none'
|
||||||
|
- },
|
||||||
|
- '2.6': {
|
||||||
|
- banner: 'none'
|
||||||
|
- },
|
||||||
|
'2.7': {
|
||||||
|
banner: 'none'
|
||||||
|
},
|
||||||
|
|
||||||
```
|
```
|
||||||
|
|
||||||
The last command starts a local development server and opens up a browser window.
|
The last command starts a local development server and opens up a browser window.
|
||||||
@ -23,15 +46,15 @@ otherwise git will refuse to change branches.
|
|||||||
This step is optional and if you don't run it, docusaurus will only build the
|
This step is optional and if you don't run it, docusaurus will only build the
|
||||||
currently checkout out version which is recommended for local development
|
currently checkout out version which is recommended for local development
|
||||||
(building all the versions locally can lead to problems with the live
|
(building all the versions locally can lead to problems with the live
|
||||||
updates when using `yarn start`).
|
updates when using `npx docusaurus start`).
|
||||||
|
|
||||||
### Build
|
### Build
|
||||||
|
|
||||||
If you only want to build the docs you can run:
|
If you only want to build the docs you can run:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ yarn clear # ensure cached content is not interfering with your changes
|
$ npm clear # ensure cached content is not interfering with your changes
|
||||||
$ yarn build
|
$ npx docusaurus build
|
||||||
```
|
```
|
||||||
|
|
||||||
This command generates static content into the `build` directory
|
This command generates static content into the `build` directory
|
||||||
@ -44,7 +67,7 @@ in development or when building the docs.
|
|||||||
To avoid this you can run:
|
To avoid this you can run:
|
||||||
|
|
||||||
```
|
```
|
||||||
$ yarn clear # ensure cached content is not interfering with your changes
|
$ npx docusaurus clear # ensure cached content is not interfering with your changes
|
||||||
$ rm -r versioned_docs versioned_sidebars versions.json # if you build multiple versions
|
$ rm -r versioned_docs versioned_sidebars versions.json # if you build multiple versions
|
||||||
```
|
```
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user