Skip to content
Create beautiful API documentation
Branch: master
Clone or download
Latest commit 34189ff Feb 2, 2017
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
includes Add function_exists checks to helper functions May 11, 2016
resources
src
tests
.gitignore
.travis.yml
LICENSE Initial commit May 10, 2016
README.md
composer.json Update dependencies Aug 26, 2016
documentarian Initial commit May 10, 2016
phpunit.xml

README.md

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?

Documentarian

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.

You can’t perform that action at this time.