# Documentation for the Litmus Project [](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_shield) [](https://slack.litmuschaos.io) [](https://hub.docker.com/r/litmuschaos/ansible-runner) [](https://github.com/litmuschaos/litmus-docs/stargazers) [](https://github.com/litmuschaos/litmus-docs/issues) [](https://github.com/litmuschaos/litmus-docs/pulls) [](https://twitter.com/LitmusChaos) [](https://www.youtube.com/channel/UCa57PMqmz_j0wnteRa9nCaw) [](https://github.com/litmuschaos/litmus-docs/pulls) [](https://github.com/litmuschaos/litmus-docs)  #### _Read this in [other languages](translations/TRANSLATIONS.md)._ [FR](translations/README-fr.md) Additional details on the Docusaurus project can be found [here](https://docusaurus.io/docs/en/installation.html). # ## For Developers ### Clone litmus-docs repository ```bash 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](https://github.com/golang/go) installed. We just need to run the following command to install embedmd. ```bash 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: ```bash 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](https://nodejs.org/en/download/). ### Start the server ```bash cd website npm install npm start ``` ## Using Docker compose ### Install Docker compose ```bash 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 ```bash docker-compose up ``` ## Browse local documentation http://localhost:3000/docs/next/getstarted.html ## License [](https://app.fossa.com/projects/git%2Bgithub.com%2Flitmuschaos%2Flitmus-docs?ref=badge_large)