Documenter

Compass documenter ships with Documentarian package by Marcel Pociot that will be used to simply write beautiful API documentation. below is the example of how it looks like:

Example of API documentation.

Yes, Documentarian is a PHP port of the popular Slate API documentation tool.

Build Documentation

When building documentation, you should run the build command:

php artisan compass:build

Next, you should be able to visit the results at yourproject.test/docs/index.html in your browser.

Rebuild Documentation

You may rebuild documentation from existing markdown file, you should run the rebuild command:

php artisan compass:rebuild