Documentation contributions are welcome and appreciated. If you find something lacking in documentation or have submitted a PR that is being merged into master, please help everyone out and write some docs!
Note: Docker is required to follow these instructions, but you can also use MkDocs natively, see details here. Ponzu docs use the "Material" theme.
Here is how to run a local docs server and build them for release:
- Clone this repository
$ git clone https://github.com/ponzu-cms/docs.git- Start the development server which will watch and auto-build the docs
$ docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material- Submit a PR with your changes. If you run the build step, please do not add it to the PR.
Thank you!