We welcome pull requests for this repository.
Make sure you have python on your system. Now install needed extensions:
pip install mkdocs pip install mkdocs-material
After you edit the documents, you can test the site by starting a dev-server:
cd docs mkdocs serve
And point browser to http://localhost:8000
The dev-server also supports auto-reloading, and will rebuild your documentation whenever anything in the configuration file, documentation directory, or theme directory changes.
Only Juji staff can deploy the site at https://docs.juji.io
You should have cloned the repo for the built site at
email@example.com:juji-io/juji-io.github.io.git, so that you should have the following file structure:
docs/ mkdocs.yml docs/ juji-io.github.io/
Now do the following to deploy the site:
cd ../juji-io.github.io/ mkdocs gh-deploy --config-file ../docs/mkdocs.yml --remote-branch master