litmuschaos
/
litmus-docs
mirror of https://github.com/litmuschaos/litmus-docs.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
Documentation for the Litmus Project
226 Commits 4 Branches 0 Tags 64 MiB
JavaScript 57.8%
HTML 22.4%
SCSS 16%
CSS 2%
Python 0.9%
Other 0.9%
Go to file
SindhuSundar1213 6a892a07bb
Adds an additional line for scope management - fixes issue #52 (#329) 
Signed-off-by: Sindhu <email.sindhu.sundar@gmail.com>
 		2025-04-14 09:17:19 +05:30
.github [docs-update]: Adding docs for 3.0.0-beta6 release (#215) 2023-04-18 21:46:33 +05:30
website Adds an additional line for scope management - fixes issue #52 (#329) 2025-04-14 09:17:19 +05:30
.dockerignore (initial-commit)beta-docs: populate beta test repo with docs 2020-10-26 13:36:58 +00:00
.gitignore updated readme, removed yarn deps (#205) 2022-09-08 19:24:05 +05:30
.gitleaksignore Updated credentials for algolia (#265) 2024-05-28 20:29:11 +05:30
CONTRIBUTING.md Added format command and fixed Prettier config (#66) 2021-07-28 19:11:59 +05:30
Dockerfile Added Workflows for CI/CD using Github Actions and ( Contributing.md and Readme.md ) Changes (#4) 2020-12-30 08:42:57 +05:30
LICENSE (initial-commit)beta-docs: populate beta test repo with docs 2020-10-26 13:36:58 +00:00
README.md Update what-is-litmus.md (#255) 2024-05-03 11:06:54 +05:30
docker-compose.yml Added setup for Docusaurus v2 and some docker-changes. 2020-11-10 17:27:10 +05:30
nginx-custom.conf (initial-commit)beta-docs: populate beta test repo with docs 2020-10-26 13:36:58 +00:00
tag.py (initial-commit)beta-docs: populate beta test repo with docs 2020-10-26 13:36:58 +00:00

README.md

LitmusChaos

Documentation for the Litmus Project

FOSSA Status Slack Channel Docker Pulls GitHub stars GitHub issues GitHub pull requests Twitter Follow YouTube Channel PRs Welcome Open Source Love GitHub top language

Read this in other languages.

FR

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

License

FOSSA Status