e402a573b6
* Added the basic layout for homepage Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Added basic components Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Removed import and component bugs Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Minor change 😅 Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Added rc files for prettier and nvm Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Adding padding for section layout Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Added Explore litmus and advanced litmus section Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Adding Home Header and fixing Explore Litmus css Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Moving to SASS (#38) Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Minor Updates Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Added CodeBlock Component for docs. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Added home page components and pre-footer Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Fixed Minor Issues with CSS and Code-reusability Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Added tutorials section Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Added chaos-hub page Signed-off-by: Amit Kumar Das <amit@chaosnative.com> * Adding Docusauras Layout Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Updated Header and Responsive Row into Sass Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Converted Link to Sass and changed baseURL Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Removed Window Object Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Updated docs/asset image Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Removing Link Underline and UI issues Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Converted Components to SASS Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Removed Theme Provider and theme hooks to migrate to SASS Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Removed styled-components modern-css-reset use-media and react-router-dom Signed-off-by: Sayan Mondal <sayan@chaosnative.com> * Added 404 page. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Added 404 page. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Added 404 page. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Added Spellcheck changes. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Fixed versioning issue in imports. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> * Fixed versioning issue in imports. Signed-off-by: Jonsy13 <vedant.shrotria@chaosnative.com> Co-authored-by: Amit Kumar Das <amit@chaosnative.com> Co-authored-by: Jonsy13 <vedant.shrotria@chaosnative.com> |
||
|---|---|---|
| .github | ||
| website | ||
| .dockerignore | ||
| .gitignore | ||
| .spellcheck.yml | ||
| .wordlist.txt | ||
| CONTRIBUTING.md | ||
| Dockerfile | ||
| LICENSE | ||
| README.md | ||
| docker-compose.yml | ||
| nginx-custom.conf | ||
| tag.py | ||
README.md
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-beta repository
git clone https://github.com/litmuschaos/litmus-docs-beta.git
cd litmus-docs-beta
The docs website server can be setup manually or through docker compose
Use embedmd command before commiting 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 get github.com/campoy/embedmd
Run embedmd (needs to be done before commiting 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.mdwill display the difference between the contents of docs-name.md and the output of embedmd docs-name.md.
Manual Setup
Install Node.js
sudo apt-get install software-properties-common
curl -sL https://deb.nodesource.com/setup_9.x | sudo -E bash -
Get the latest Node.js package
sudo apt-get install -y nodejs
Install Yarn
npm install -g yarn
Start the server
cd website
yarn install
yarn 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
