Get the latest Laravel/PHP jobs, events and curated articles straight to your inbox, once a week
Source: github.com
Laravel EnlightenCategory: Laravel, api, javascript
Enlighten your APIs with auto-generated documentation Use Git or checkout with SVN using the web URL.
Enlighten your Laravel applications with a beautiful documentation generated automatically from your test suites, by doing so, your documentation will always be updated with the current version of your app.
To "group" your tests-classes as "modules", you can use a regular expression to find all the classes that match with the given pattern or patterns: You can add a "catch all" group at the end to include all those files that didn't match with any of the other patterns, otherwise Enlighten will do this automatically for you. If you want to include all the test-classes and methods in your documentation, you can skip this step, otherwise, you can add the following key to the /config/enlighten.php file: If you want to have more control on the titles of the classes and methods, or add descriptions to each group or example, you can add the following annotations in your test classes and methods: To customize the content of your Dashboard page, you can add an ENLIGHTEN.md markdown file to the root path of your project.
Enlighten your Laravel applications with a beautiful documentation generated automatically from your test suites, by doing so, your documentation will always be updated with the current version of your app.
To "group" your tests-classes as "modules", you can use a regular expression to find all the classes that match with the given pattern or patterns: You can add a "catch all" group at the end to include all those files that didn't match with any of the other patterns, otherwise Enlighten will do this automatically for you. If you want to include all the test-classes and methods in your documentation, you can skip this step, otherwise, you can add the following key to the /config/enlighten.php file: If you want to have more control on the titles of the classes and methods, or add descriptions to each group or example, you can add the following annotations in your test classes and methods: To customize the content of your Dashboard page, you can add an ENLIGHTEN.md markdown file to the root path of your project.
Newsletter
ToastMail
Achieve superior email deliverability with ToastMail! Our AI-driven tool warms up inboxes, monitors reputation, and ensures emails reach their intended destination. Sign up today for a spam-free future.
Community Partners
Laravel/PHP Careers