(commands) Added Readme Changes for Versioning command. (#7)
* Added Readme Changes. Signed-off-by: Vedant Shrotria <vedant.shrotria@mayadata.io> * Removed edited type from workflow. Signed-off-by: Vedant Shrotria <vedant.shrotria@mayadata.io> * Updated the documentation. Signed-off-by: Vedant Shrotria <vedant.shrotria@mayadata.io>
This commit is contained in:
parent
1992ffc3f3
commit
02b7f0253f
|
|
@ -1,7 +1,7 @@
|
||||||
name: LitmusDocs-CI
|
name: LitmusDocs-CI
|
||||||
on:
|
on:
|
||||||
pull_request:
|
pull_request:
|
||||||
types: [ opened, synchronize, reopened, edited ]
|
types: [ opened, synchronize, reopened ]
|
||||||
paths:
|
paths:
|
||||||
- '.github/workflows/dockerbuild.yml'
|
- '.github/workflows/dockerbuild.yml'
|
||||||
- '.github/workflows/Pull_Request.yml'
|
- '.github/workflows/Pull_Request.yml'
|
||||||
|
|
|
||||||
|
|
@ -5,13 +5,13 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern
|
||||||
## Installation
|
## Installation
|
||||||
|
|
||||||
```console
|
```console
|
||||||
yarn install
|
npm install
|
||||||
```
|
```
|
||||||
|
|
||||||
## Local Development
|
## Local Development
|
||||||
|
|
||||||
```console
|
```console
|
||||||
yarn start
|
npm start
|
||||||
```
|
```
|
||||||
|
|
||||||
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
This command starts a local development server and open up a browser window. Most changes are reflected live without having to restart the server.
|
||||||
|
|
@ -19,11 +19,20 @@ This command starts a local development server and open up a browser window. Mos
|
||||||
## Build
|
## Build
|
||||||
|
|
||||||
```console
|
```console
|
||||||
yarn build
|
npm run build
|
||||||
```
|
```
|
||||||
|
|
||||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||||
|
|
||||||
|
## Versioning
|
||||||
|
|
||||||
|
```console
|
||||||
|
npm run docusaurus docs:version <VERSION>
|
||||||
|
```
|
||||||
|
|
||||||
|
This command will tag a new version from master docs.
|
||||||
|
It will copy the docs/ folder contents into a new versioned_docs/version-`<version>`/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-`<version>`-sidebars.json and append the new version number to versions.json.
|
||||||
|
|
||||||
## Deployment
|
## Deployment
|
||||||
|
|
||||||
```console
|
```console
|
||||||
|
|
|
||||||
Loading…
Reference in New Issue