A simple style-guide for building RESTful documentation in Markdown, inspired by the Github Developer API.
There are so many ways to create documentation for your RESTful API. However, sometimes you just want something simple to publish along with your git repository. This project aims at utilizing Github Flavored Markdown to create a simple documentation of your RESTful API. No generators, compilers or any fluff, just Markdown.
Clone, fork, or just view the examples directory for a documentation example.
Resources to help with the style guide.
- http://restful-api-design.readthedocs.org/
- https://developer.github.com/v3/
- https://help.github.com/articles/github-flavored-markdown/
Contributions are welcome! Feel free to create an issue or pull request!
To the extent possible under law, alfg has waived all copyright and related or neighboring rights to this work.