Giter Club home page Giter Club logo

docs's Introduction

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. Ponzu docs use the "Material" theme.

Here is how to run a local docs server and build them for release:

  1. Clone this repository
$ git clone https://github.com/ponzu-cms/docs.git
  1. 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
  1. Submit a PR with your changes. If you run the build step, please do not add it to the PR.

Thank you!

docs's People

Contributors

ivanov avatar nilslice avatar

Stargazers

avatar avatar avatar

Watchers

avatar avatar avatar avatar

Forkers

ivanov itzsaga michaweber

docs's Issues

Use ponzu to make docs

It's possible to use Hugo but we can actually make it work off the go code in ponzu.

Godoc to markdown.
Markdown into Hugo.
Ponzu running under it all watching the source GitHub tags and kicking it off.

I think by using ponzu the search functionality will be much better in the web GUI.

I think this is just a matter of bolting together the right pieces.

Here is a noteworthy example that uses this same approach.
https://snipcart.com/blog/golang-ecommerce-ponzu-cms-demo

This will mean that people that build ponzu add-ons or full projects also get this automatic documentation system too

This is also a good PR for someone starting ponzu.

Can't Run Dev Server

Running the docker command produces the following error:
ERROR - Config value: 'markdown_extensions'. Error: Failed loading extension "codehilite(linenums=false)".

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.