# Documentarian
#### Simply write beautiful API documentation.
========


![image](http://img.shields.io/packagist/v/mpociot/documentarian.svg?style=flat)
![image](http://img.shields.io/packagist/l/mpociot/documentarian.svg?style=flat)
[![codecov.io](https://codecov.io/github/mpociot/documentarian/coverage.svg?branch=master)](https://codecov.io/github/mpociot/documentarian?branch=master)
[![Scrutinizer Code Quality](https://scrutinizer-ci.com/g/mpociot/documentarian/badges/quality-score.png?b=master)](https://scrutinizer-ci.com/g/mpociot/documentarian/?branch=master)
[![Build Status](https://travis-ci.org/mpociot/documentarian.svg?branch=master)](https://travis-ci.org/mpociot/documentarian)


This project is a PHP port of the popular [Slate](https://github.com/tripit/slate) API documentation tool.

> If PHP is not your thing and you're more into nodeJS, why not give [Whiteboard](https://github.com/mpociot/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](http://marcelpociot.de/whiteboard/).

The documentation is available at [http://marcelpociot.com/documentarian/installation](http://marcelpociot.de/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](https://github.com/mpociot/documentarian/issues).

### In depth documentation
For further documentation, read the [documentation](http://marcelpociot.de/documentarian/installation).

### Documentations built with Documentarian

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

### Contributors

Slate was built by [Robert Lord](https://lord.io) while at [TripIt](http://tripit.com).

Documentarian was built by Marcel Pociot.