snowsoft / documentarian
Installs: 50
Dependents: 1
Suggesters: 0
Security: 0
Stars: 0
Watchers: 0
Forks: 91
Language:JavaScript
Requires
- php: >=8.0.0
- illuminate/view: 5.*|^6.0|^7.0|^8.0|^9.0|^10.0
- mnapoli/front-yaml: ^2.0.2
- mnapoli/silly: ~1.8.1
- windwalker/renderer: 3.*
Requires (Dev)
- phpunit/phpunit: ^10.0.1
This package is auto-updated.
Last update: 2024-11-15 15:50:13 UTC
README
Simply write beautiful API documentation.
========
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?
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.