History

Sayan Mondal 75f8c94cd2 Removed Verification Checks from Docs Signed-off-by: Sayan Mondal <sayan@chaosnative.com>		2021-03-15 19:49:45 +05:30
..
build	Create .gitkeep (#6 )	2021-01-04 18:56:41 +05:30
docs	Removed Verification Checks from Docs	2021-03-15 19:49:45 +05:30
src	Adding beta-0 version of new docs- first draft	2021-01-04 17:43:05 +05:30
static	Added setup for Docusaurus v2 and some docker-changes.	2020-11-10 17:27:10 +05:30
versioned_docs	Adding beta-0 version of new docs- first draft	2021-01-04 17:43:05 +05:30
versioned_sidebars	Adding beta-0 version of new docs- first draft	2021-01-04 17:43:05 +05:30
README.md	(commands) Added Readme Changes for Versioning command. (#7 )	2021-01-13 11:45:56 +05:30
babel.config.js	Added setup for Docusaurus v2 and some docker-changes.	2020-11-10 17:27:10 +05:30
docusaurus.config.js	Architecture Doc Section	2021-03-12 13:18:53 +05:30
package.json	Added Fresh Setup for Version 2.0	2021-03-09 17:25:05 +05:30
sidebars.js	Added Litmus Installation	2021-03-15 17:41:14 +05:30
versions.json	Adding beta-0 version of new docs- first draft	2021-01-04 17:43:05 +05:30

README.md

Website

This website is built using Docusaurus 2, a modern static website generator.

Installation

npm install

Local Development

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.

Build

npm run build

This command generates static content into the build directory and can be served using any static contents hosting service.

Versioning

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

GIT_USER=<Your GitHub username> USE_SSH=true yarn deploy

If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the gh-pages branch.