https://github.com/alfg/restful-markdown

:pencil: A simple style-guide for building RESTful documentation in Markdown.
https://github.com/alfg/restful-markdown

github markdown standard

Last synced: 30 days ago
JSON representation

:pencil: A simple style-guide for building RESTful documentation in Markdown.

• Host: GitHub
• URL: https://github.com/alfg/restful-markdown
• Owner: alfg
• Created: 2015-05-11T00:00:17.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2015-05-11T03:24:17.000Z (about 11 years ago)
• Last Synced: 2025-04-12T22:55:32.824Z (about 1 year ago)
• Topics: github, markdown, standard
• Homepage:
• Size: 184 KB
• Stars: 3
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# restful-markdown

A simple style-guide for building RESTful documentation in Markdown, inspired by the [Github Developer API](https://developer.github.com/v3/).

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](https://help.github.com/articles/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](examples) directory for a documentation example.

## Resources

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/

## Contribute

Contributions are welcome! Feel free to create an issue or pull request!

## License

[![CC0](http://i.creativecommons.org/p/zero/1.0/88x31.png)](http://creativecommons.org/publicdomain/zero/1.0/)

To the extent possible under law, [alfg](http://github.com/alfg) has waived all copyright and related or neighboring rights to this work.