diff --git a/.github/workflows/Pull_Request.yml b/.github/workflows/Pull_Request.yml index 974bc1f..129d840 100644 --- a/.github/workflows/Pull_Request.yml +++ b/.github/workflows/Pull_Request.yml @@ -1,7 +1,7 @@ name: LitmusDocs-CI on: pull_request: - types: [ opened, synchronize, reopened, edited ] + types: [ opened, synchronize, reopened ] paths: - '.github/workflows/dockerbuild.yml' - '.github/workflows/Pull_Request.yml' diff --git a/website/README.md b/website/README.md index 8960fa2..c35c7f3 100644 --- a/website/README.md +++ b/website/README.md @@ -5,13 +5,13 @@ This website is built using [Docusaurus 2](https://v2.docusaurus.io/), a modern ## Installation ```console -yarn install +npm install ``` ## Local Development ```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. @@ -19,11 +19,20 @@ This command starts a local development server and open up a browser window. Mos ## Build ```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. +## Versioning + +```console +npm run docusaurus docs:version +``` + +This command will tag a new version from master docs. +It will copy the docs/ folder contents into a new versioned_docs/version-``/ folder, create a versioned sidebars file based from your current sidebar configuration (if it exists) - saved as versioned_sidebars/version-``-sidebars.json and append the new version number to versions.json. + ## Deployment ```console