PHPackages desilva/laradocgen - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. desilva/laradocgen AbandonedArchivedLibrary[Utility & Helpers](/categories/utility) desilva/laradocgen ================== Generates static HTML documentation for Laravel based on Markdown with a realtime preview. v1.0.6(1y ago)082MITPHPPHP ^8.0.2 Since Mar 1Pushed 1y ago1 watchersCompare [ Source](https://github.com/caendesilva/laradocgen)[ Packagist](https://packagist.org/packages/desilva/laradocgen)[ Docs](https://github.com/caendesilva/laradocgen)[ Fund](https://www.buymeacoffee.com/caen)[ RSS](/packages/desilva-laradocgen/feed)WikiDiscussions master Synced today READMEChangelog (8)Dependencies (6)Versions (9)Used By (0) Laravel Static Documentation Sites, Blazingly Fast and Stupidly Simple ====================================================================== [](#laravel-static-documentation-sites-blazingly-fast-and-stupidly-simple) [![Latest Version on Packagist](https://camo.githubusercontent.com/6b0e0b502b96f21456a8d623ffa80af5b0bcd348560698eb2ff41ff207a6309f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e)](https://camo.githubusercontent.com/6b0e0b502b96f21456a8d623ffa80af5b0bcd348560698eb2ff41ff207a6309f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e) [![Total Downloads](https://camo.githubusercontent.com/75510bf65b82509566e7752f5d531cd73bde512a349be00c7e25d0bae9a317c2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646573696c76612f6c617261646f6367656e)](https://camo.githubusercontent.com/75510bf65b82509566e7752f5d531cd73bde512a349be00c7e25d0bae9a317c2/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f64742f646573696c76612f6c617261646f6367656e) [![License](https://camo.githubusercontent.com/a45f97d729e20b9ba3c21fd7fffcd7ba18e88e9023f7a0b194722bbf5fcfee30/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f646573696c76612f6c617261646f6367656e)](https://camo.githubusercontent.com/a45f97d729e20b9ba3c21fd7fffcd7ba18e88e9023f7a0b194722bbf5fcfee30/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f6c2f646573696c76612f6c617261646f6367656e) [![GitHub Actions](https://github.com/caendesilva/laradocgen/actions/workflows/php.yml/badge.svg)](https://github.com/caendesilva/laradocgen/actions/workflows/php.yml/badge.svg) [![GitHub Actions](https://github.com/caendesilva/Laradocgen/actions/workflows/laravel-tests.yml/badge.svg)](https://github.com/caendesilva/Laradocgen/actions/workflows/laravel-tests.yml/badge.svg) > Now with Dark Mode Support! Not activly maintained ---------------------- [](#not-activly-maintained) This project is currently not receiving new features as I am focusing on [HydePHP](https://github.com/hydephp/hyde), however, the project will continue to get security fixes indefinitely. Open source contributions are welcome! ### Alternatives [](#alternatives) This project is a hybrid static site generator and live server package. I have created two other packages that I think are much better suited than this one. If you want static documentation sites, try out [HydePHP](http://hydephp.com/) which features a significantly faster rendering engine, and is much more refined and easy to get started with. If you want documentation sites for a Laravel project, try [Lagrafo](https://github.com/caendesilva/lagrafo), which started out as Laradocgen v2.0. About ----- [](#about) Hey! I'm Caen! I created this package to practice package development. It is still very much in beta, but please do send me any feedback you have! I'd love to get some PRs as well. ### Full Documentation [](#full-documentation) Full documentation is available at . Generated using this package of course! ### Alpha Stage Software [](#alpha-stage-software) Hey! Just a quick heads up that this is a very new package and I expect there to be bugs. If anything goes wrong, do let me know and I'd love to get feedback and PRs! \*\*Disclaimer\*\* This package is still in the alpha stage. Once it becomes stable and tested enough I will release v1.0 and I will adhere to semantic versioning. But until then I will run canary builds and I am sure there will be breaking changes. I will of course do my best to document them all in the upgrade guides, but all in all, at this stage I would not recommend it for production use. Though since it is intended to run on your local server I don't think much can go wrong as long as you have backups and Git. The only area that is really of concern to me is that since we are working with writing files to disk if something goes wrong files could be overwritten, but as it is now the paths are hardcoded to "safe" directories so it should only be able to overwrite files already created by the package. Installation ------------ [](#installation) > The package has so far only been tested with Laravel 9 You can install the package via composer: ``` composer require desilva/laradocgen --dev ``` Publish the assets ``` php artisan vendor:publish --tag="laradocgen" ``` Build the static site ``` php artisan laradocgen:build ``` Your static site will be saved in `public/docs` Usage ----- [](#usage) ### Adding pages [](#adding-pages) Pages are generated from markdown files stored in `resources/docs/`. Markdown filenames are sanitized through Str::slug(). To prevent 404 errors the filenames must be compatible. In essence, they must be in lowercase kebab-case and end in .md and must not contain spaces. ``` ❌ "kebab case title.markdown" # Returns 404 ✔️ "kebab-case-title.md" # creates my-page-title.html and renders as "My Page Title" in the frontend ``` And store your images in `resources/docs/media/` ``` ![My Image](media/image.png "Image Title") # Note the relative path ``` ### Build the static site [](#build-the-static-site) ``` php artisan laradocgen:build ``` Your static site will be saved in `public/docs` ### Customization [](#customization) The package strives to follow [Convention over configuration](https://en.wikipedia.org/wiki/Convention_over_configuration). Everything is preconfigured so you can get started quickly. However, if you wish you can customize the package. You can publish the Blade views using ``` php artisan publish --tag="laradocgen-views" ``` And customize them to your liking. Note that you will need to re-publish the views when updating! You can customize the source and output directory in the config file. You can use this to create multiple documentation versions. Package Development ------------------- [](#package-development) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Changelog --------- [](#changelog) Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. Contributing ------------ [](#contributing) Please see [CONTRIBUTING](CONTRIBUTING.md) for details. ### Roadmap [](#roadmap) - Allow the specification of source/build directories. This can also be used for versioning. - Document Blade [view customization](https://laravel.com/docs/9.x/packages#views) - Add (automatic) versioning support - Allow the package to run standalone from Laravel - Add Search feature - Add Artisan command to create a new Markdown file based on an input title - Add CLI options to the Artisan build command to override config settings on a per-build basis Right now there are not very many customization options as I wanted to keep things dead simple. If you have a configuration idea please do make a PR or open a GitHub Issue as I want to allow for more customization down the line. Security -------- [](#security) If you discover any security-related issues, please email instead of using the issue tracker. All vulnerabilities will be promptly addressed. Credits ------- [](#credits) - [Caen De Silva](https://github.com/caendesilva) - [All Contributors](../../contributors) License ------- [](#license) The MIT License (MIT). Please see [License File](LICENSE.md) for more information. Attributions ------------ [](#attributions) > Please see the respective authors' repositories for their license files ### Laravel Package Boilerplate [](#laravel-package-boilerplate) This package's scaffolding was generated using the [Laravel Package Boilerplate](https://laravelpackageboilerplate.com). ### Frontend [](#frontend) - The frontend is based on the [Tailwind Starter Kit](https://github.com/creativetimofficial/tailwind-starter-kit) from Creative Tim (MIT) - The dark-mode switch is based on a component from [Flowbite](https://flowbite.com/docs/customize/dark-mode/) (MIT) ### Packages used and special mentions [](#packages-used-and-special-mentions) - The frontend is built with [TailwindCSS](https://tailwindcss.com/) - Syntax highlighting by [Torchlight](https://torchlight.dev/) - Markdown is parsed with [League/Commonmark](https://github.com/thephpleague/commonmark) - The default favicon was created using [Favicon.io](https://favicon.io/) using the ["Page" Emoji](https://github.com/twitter/twemoji/blob/master/assets/svg/1f4c4.svg) from the amazing open-source project [Twemoji](https://twemoji.twitter.com/). The graphics are copyright 2020 Twitter, Inc and other contributors and are licensed under [CC-BY 4.0](https://creativecommons.org/licenses/by/4.0/). More Badges ----------- [](#more-badges) [![Latest Version on Packagist](https://camo.githubusercontent.com/6b0e0b502b96f21456a8d623ffa80af5b0bcd348560698eb2ff41ff207a6309f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e)](https://camo.githubusercontent.com/6b0e0b502b96f21456a8d623ffa80af5b0bcd348560698eb2ff41ff207a6309f/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e) [![Latest Version on Packagist (including pre-releases)](https://camo.githubusercontent.com/b31443ea623bf59b7d47f9b19c36df3cddbe5a48442062539f68922d2d813252/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e3f696e636c7564655f70726572656c6561736573)](https://camo.githubusercontent.com/b31443ea623bf59b7d47f9b19c36df3cddbe5a48442062539f68922d2d813252/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f646573696c76612f6c617261646f6367656e3f696e636c7564655f70726572656c6561736573) [![GitHub Actions](https://github.com/caendesilva/Laradocgen/actions/workflows/pages/pages-build-deployment/badge.svg)](https://github.com/caendesilva/Laradocgen/actions/workflows/pages/pages-build-deployment/badge.svg) ### Health Score 31 — LowBetter than 66% of packages Maintenance36 Infrequent updates — may be unmaintained Popularity9 Limited adoption so far Community9 Small or concentrated contributor base Maturity59 Maturing project, gaining track record Bus Factor1 Top contributor holds 92.7% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~164 days Recently: every ~225 days Total 7 Last Release 596d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/71ba01b4aa7fbc633c6fe6630b573400b40928d79574b657eb8d45524ca28aa0?d=identicon)[caendesilva](/maintainers/caendesilva) --- Top Contributors [![emmadesilva](https://avatars.githubusercontent.com/u/95144705?v=4)](https://github.com/emmadesilva "emmadesilva (230 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (18 commits)") --- Tags documentationlaradocgenlaravellaraveldocumentationdesilvastatic site builderlaradocgen ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/desilva-laradocgen/health.svg) ``` [![Health](https://phpackages.com/badges/desilva-laradocgen/health.svg)](https://phpackages.com/packages/desilva-laradocgen) ``` ### Alternatives [psalm/plugin-laravel Psalm plugin for Laravel 3355.3M346](/packages/psalm-plugin-laravel)[renatomarinho/laravel-page-speed Laravel Page Speed 2.5k1.7M11](/packages/renatomarinho-laravel-page-speed)[helsingborg-stad/municipio A bootstrap theme for creating municipality sites. 4028.5k10](/packages/helsingborg-stad-municipio)[vinkius-labs/laravel-page-speed Laravel Page Speed 2.5k12.5k1](/packages/vinkius-labs-laravel-page-speed)[illuminate/mail The Illuminate Mail package. 5910.6M497](/packages/illuminate-mail)[emargareten/inertia-modal Inertia Modal is a Laravel package that lets you implement backend-driven modal dialogs for Inertia apps. 90142.9k](/packages/emargareten-inertia-modal) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)