hanifhefaz / documentation-generator
A Laravel package to generate technical documentation.
Installs: 31
Dependents: 0
Suggesters: 0
Security: 0
Stars: 1
Watchers: 1
Forks: 0
Open Issues: 0
pkg:composer/hanifhefaz/documentation-generator
Requires
- php: ^7.4|^8.0
- erusev/parsedown: ^1.7
README
A Laravel package to generate technical documentation for your Laravel project.
Installation
composer require hanifhefaz/documentation-generator
Usage
Run the following command to generate full documentation:
php artisan docs:generate path/to/your/project/
Run the following command to generate documentation based on exclusions. You can exclude any directory that you dont want to generate documentation for.
php artisan docs:generate path/to/your/project --excludeDir=name/of/the/directory
After running one of the commands above, you can enter the main information required for the documentation as well as the format of your documentation:
That is it.