Documentation for the Litmus Project

Read this in other languages.

Additional details on the Docusaurus project can be found here.

For Developers

Clone litmus-docs repository

git clone https://github.com/litmuschaos/litmus-docs.git
cd litmus-docs

The docs website server can be setup manually or through docker compose

Use embedmd command before committing changes

The embedded code will be extracted from the file at URL, which can either be a relative path to a file in the local file system (using forward slashes as directory separator) or a URL starting with http:// or https://.

Installation:

Make sure you have golang installed. We just need to run the following command to install embedmd.

go install github.com/campoy/embedmd@latest

Run embedmd (needs to be done before committing the changes):

Follow the steps (from root directory) to run embedmd:

cd website/docs
embedmd -w $(find **/*.md)

Check the difference:

Executing embedmd -d docs-name.md will display the difference between the contents of docs-name.md and the output of embedmd docs-name.md.

Manual Setup

Pre-Requisites

Node.js 16.14 or above. It can be installed from here.

Start the server

cd website
npm install
npm start

Using Docker compose

Install Docker compose

sudo curl -L "https://github.com/docker/compose/releases/download/1.24.1/docker-compose-$(uname -s)-$(uname -m)" -o /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose

Run the server

docker-compose up

Browse local documentation

http://localhost:3000/docs/next/getstarted.html