anupriya0703 / litmus-docs Goto Github PK

Documentation for the Litmus Project

Additional details on the Docusaurus project can be found here.

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

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

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 always forward slashes as directory separator) or a URL starting with http:// or https://.

Flags (needs to be done before commiting the changes):

-w: Executing embedmd -w docs.md will modify docs.md and add the corresponding code snippets, as shown in sample/result.md.

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

sudo apt-get install software-properties-common
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -

sudo apt-get install -y nodejs

npm install -g yarn

cd website
yarn install
yarn start

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

docker-compose up

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