blob: 990cd9236c20cae811a2e842dfbda988ed4292e7 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
|
# Ponzu CMS + Server Framerwork Docs
## Contributing
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](http://www.mkdocs.org/#installation). Ponzu
docs use the "Material" [theme](http://squidfunk.github.io/mkdocs-material/).
Here is how to run a local docs server and build them for release:
1. Clone this repository
```bash
$ git clone https://github.com/ponzu-cms/docs.git
```
2. Start the development server which will watch and auto-build the docs
```bash
$ docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material
```
3. Submit a PR with your changes. If you run the build step, please do not add it to the PR.
**Thank you!**
|
