Docify Laravel Package
techenby/docify
Docify is a simple Markdown documentation viewer for Laravel TALL apps. Install via Artisan to generate a docs folder, optionally publish config and views, and control which environments can access it. Supports an Edit link using DOCIFY_EDITOR (or Debugbar/Ignition) defaults.
A simple markdown viewer for TALL stack applications
Installation
You can install the package via composer:
composer require techenby/docify
Then run the install command to generate a docs folder:
php artisan docify:install
Optionally, you can publish the config and Livewire component and docs layout to configure the package for your application:
php artisan vendor:publish
Usage
By default, Docify is only viewable when your Laravel application is running in the local environment.
To allow additional environments, publish the config file and update environments:
'environments' => ['local', 'staging'],
Set the local editor used by the Edit link with DOCIFY_EDITOR. If it is not set, Docify will also check DEBUGBAR_EDITOR and IGNITION_EDITOR before defaulting to VS Code.
DOCIFY_EDITOR=cursor
Testing
composer test
Releasing
Please see RELEASE.md for the release process.
Contributing
Please see CONTRIBUTING for details.
Security
If you discover any security related issues, please email [email protected] instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.
How can I help you explore Laravel packages today?