https://github.com/ponzu-cms/docs
Documentation for Ponzu
https://github.com/ponzu-cms/docs
docs documentation golang mkdocs ponzu ponzu-cms
Last synced: 19 days ago
JSON representation
Documentation for Ponzu
- Host: GitHub
- URL: https://github.com/ponzu-cms/docs
- Owner: ponzu-cms
- License: bsd-3-clause
- Created: 2017-05-02T20:43:00.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2019-05-09T15:17:34.000Z (almost 6 years ago)
- Last Synced: 2025-03-25T03:27:31.464Z (about 1 month ago)
- Topics: docs, documentation, golang, mkdocs, ponzu, ponzu-cms
- Language: HTML
- Homepage: https://docs.ponzu-cms.org
- Size: 511 KB
- Stars: 3
- Watchers: 3
- Forks: 3
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# 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!**