History

Adarshkumar14 5dc0e7d0fe Updating the Namespace Installation guide (#188 ) * adding doc for 2.9.0 Signed-off-by: Adarshkumar14 <adarsh.kumar@harness.io> * updating the namespace Installation guide Signed-off-by: Adarshkumar14 <adarsh.kumar@harness.io> * upating litmusctl documentation Signed-off-by: Adarshkumar14 <adarsh.kumar@harness.io> * updating master doc Signed-off-by: Adarshkumar14 <adarsh.kumar@harness.io> * some minor changes Signed-off-by: Adarshkumar14 <adarsh.kumar@harness.io>		2022-05-18 14:53:29 +05:30
..
docs	Updating the Namespace Installation guide (#188 )	2022-05-18 14:53:29 +05:30
src	Functionality for Dark-Mode in Litmus Docs 2.0 (#131 )	2021-10-22 17:05:49 +05:30
static	updated FAQ link in the footer (#182 )	2022-05-04 16:34:47 +05:30
versioned_docs	Updating the Namespace Installation guide (#188 )	2022-05-18 14:53:29 +05:30
versioned_sidebars	adding doc for 2.9.0 (#187 )	2022-05-16 23:53:14 +05:30
.prettierrc	Added format command and fixed Prettier config (#66 )	2021-07-28 19:11:59 +05:30
README.md	(commands) Added Readme Changes for Versioning command. (#7 )	2021-01-13 11:45:56 +05:30
babel.config.js	Added format command and fixed Prettier config (#66 )	2021-07-28 19:11:59 +05:30
docusaurus.config.js	Updated API docs link (#186 )	2022-05-16 12:31:36 +05:30
package-lock.json	Adding docs for 2.7.0 release (#174 )	2022-04-05 10:03:48 +05:30
package.json	Added CN Litmus Cloud Installation Docs (#161 )	2022-01-11 12:40:11 +05:30
sidebars.js	add: dex installation documentation for `litmusportal` (#134 )	2021-10-19 19:39:12 +05:30
versions.json	adding doc for 2.9.0 (#187 )	2022-05-16 23:53:14 +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.