Home

Awesome

Documentarian

Simply write beautiful API documentation.

========

image image codecov.io Scrutinizer Code Quality Build Status

This project is a PHP port of the popular Slate API documentation tool.

If PHP is not your thing and you're more into nodeJS, why not give Whiteboard a try?

<a href="http://marcelpociot.de/whiteboard/"><img src="http://marcelpociot.de/git/whiteboard_responsive.jpg" style="width: 100%" alt="Documentarian" /></a>

Check out a Documentarian example API documentation.

The documentation is available at http://marcelpociot.com/documentarian/installation

Slate / Whiteboard compatibility

Since both Documentarian and Slate use regular markdown files to render the API documentation, your existing Slate API documentation should work just fine. If you encounter any issues, please submit an issue.

In depth documentation

For further documentation, read the documentation.

Documentations built with Documentarian

Feel free to submit a PR with a link to your documentation.

Contributors

Slate was built by Robert Lord while at TripIt.

Documentarian was built by Marcel Pociot.