desilva / lagrafo
To the point documentation app generator for Laravel.
Fund package maintenance!
www.buymeacoffee.com/caen
Requires
- php: ^8.0.2
- illuminate/support: ^9.0
- league/commonmark: ^2.3
- spatie/yaml-front-matter: ^2.0
- torchlight/torchlight-commonmark: ^0.5.5
Requires (Dev)
- orchestra/testbench: ^7.0
- phpunit/phpunit: ^9.0
This package is auto-updated.
Last update: 2024-12-27 18:18:14 UTC
README
Important I'm #CodingInPublic, this is not at all ready for production use.
Lagrafo is a simple to the point, documentation site package for Laravel, built to just get some damn documentation without any fuss, configuration, or code.
The package is opinionated and may not suit your needs. I originally created it for my own use, and don't intend to spending a lot of time on adding an extensive feature set to it. If you want a more robust and highly customizable static documentation site, check ouy my other project, HydePHP at hydephp.github.io!
This package is still in development and is not suited for production use. Versions in the v0.x range have no backwards-compatibility guarantees.
Installation
You can install the package via composer:
composer require desilva/lagrafo
Frontend Assets
The frontend styles and scripts are served through the jsDelivr CDN. They are added here for reference, but are already included in the layout.
<link rel="stylesheet" href="https://cdn.jsdelivr.net/gh/caendesilva/lagrafo@v0.1.0-beta/dist/lagrafo.min.css"> <script defer src="https://cdn.jsdelivr.net/gh/caendesilva/lagrafo@v0.1.0-beta/dist/lagrafo.min.js"></script>
Usage
Place markdown files in the resources/docs directory,
and access them through the /docs/<markdown-slug> route.
Lagrafo does not really offer any customization options, though you can override the automatic sidebar order and labels using optional front matter.
About
Features
- Markdown documentation files are automatically discovered
- Automatic sidebar
- No configuration
- Laravel powered routing
- Lightweight frontend
- Basic search feature that can return API results
Screenshot
Resources
Contributing
Feel free to fork the project and submit pull requests! I'd love to get proper tests in place, if that's something you're interested in.
Security
If you discover any security related issues, please email caen@desilva.se instead of using the issue tracker.
Credits
License
The MIT License (MIT). Please see License File for more information.