github.com/bosssauce/ponzu@v0.11.1-0.20200102001432-9bc41b703131/docs/README.md (about)

     1  # Ponzu CMS + Server Framerwork Docs
     2  
     3  ## Contributing
     4  
     5  Documentation contributions are welcome and appreciated. If you find something 
     6  lacking in documentation or have submitted a PR that is being merged into master, 
     7  please help everyone out and write some docs! 
     8  
     9  **Note:** Docker is required to follow these instructions, but you can also use
    10  MkDocs natively, [see details here](http://www.mkdocs.org/#installation). Ponzu
    11  docs use the "Material" [theme](http://squidfunk.github.io/mkdocs-material/).
    12  
    13  
    14  Here is how to run a local docs server and build them for release:
    15  
    16  1. Clone this repository
    17  ```bash
    18  $ git clone https://github.com/ponzu-cms/docs.git
    19  ``` 
    20  2. Start the development server which will watch and auto-build the docs
    21  ```bash
    22  $ docker run --rm -it -p 8000:8000 -v `pwd`:/docs squidfunk/mkdocs-material
    23  ``` 
    24  3. Submit a PR with your changes. If you run the build step, please do not add it to the PR.
    25  
    26  **Thank you!**