Deprecated, see new docs at https://docs.kadena.io/
This project contains the old documentation used to support the old Kadena Docs resource site.
The new documentation site is at https://docs.kadena.io/, and it will be open sourced soon.
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
clone the repository
To make updates to this site you need to complete the following steps.
git add .
git commit -m 'short description of changes goes here'
git push -u origin master
To preview changes, run the following command:
mkdocs serve
And navigate to http://127.0.0.1:8000 on your browser.
Deploy these changes to the live site (AVOID until going live)
mkdocs gh-deploy --clean
You can also serve, build, and deploy with the mkdocs-material docker container as described here:
https://hub.docker.com/r/squidfunk/mkdocs-material/
The following single command should deploy an updated site:
docker run --rm -it -v ~/.ssh:/root/.ssh -v ${PWD}:/docs squidfunk/mkdocs-material gh-deploy