litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
litmus-docs/website
History
Vedant Shrotria 58c95e34c1
Updated the favicon icon & Readme.md. (#95) 
* Updated the favicon icon & Readme.md.

Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com>

* Update README.md
 		2021-08-14 22:54:36 +05:30
..
build Added a New Version 2.0.0-Beta-1. (#22) 2021-03-16 00:58:57 +05:30
docs Architecture Docs (#87) 2021-08-14 22:06:29 +05:30
src Updated fonts, changed observe worflow to visualize workflow and fixed broken links (#94) 2021-08-14 21:19:57 +05:30
static Updated the favicon icon & Readme.md. (#95) 2021-08-14 22:54:36 +05:30
versioned_docs Changed 2.0.0-Beta to 2.0.0 (Except Helm) + Modifed Homepage (#88) 2021-08-14 16:01:49 +05:30
versioned_sidebars Adding Version 2.0.0-Beta8 Docs. (#41) 2021-06-16 00:00:04 +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 fonts, changed observe worflow to visualize workflow and fixed broken links (#94) 2021-08-14 21:19:57 +05:30
package-lock.json Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
package.json Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
sidebars.js Architecture Docs (#87) 2021-08-14 22:06:29 +05:30
versions.json type(migration): Adding Litmus Docs 2.0 website with SASS (#46) 2021-06-30 13:14:43 +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.