PHPackages rex-devs/lara-docs-kit - 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. rex-devs/lara-docs-kit ActiveLibrary rex-devs/lara-docs-kit ====================== A Laravel documentation package, that adds the ability to add multiple documentation sections to an existing site, while also choosing custom urls for each. v1.0.0(2y ago)04[1 issues](https://github.com/rex-devs/lara-docs-kit/issues)MITPHPPHP ^8.1 Since Sep 16Pushed 2y ago1 watchersCompare [ Source](https://github.com/rex-devs/lara-docs-kit)[ Packagist](https://packagist.org/packages/rex-devs/lara-docs-kit)[ GitHub Sponsors](https://github.com/JustinByrne)[ RSS](/packages/rex-devs-lara-docs-kit/feed)WikiDiscussions main Synced 1mo ago READMEChangelog (1)Dependencies (8)Versions (2)Used By (0) Lara Docs Kit ============= [](#lara-docs-kit) Welcome to lara-docs-kit, a powerful Laravel documentation package. This package aims to simplify the process of creating and managing documentation for your Laravel projects. Installation ------------ [](#installation) To get started with lara-docs-kit, follow these simple steps: 1. Install the package via Composer: ``` composer require rex-devs/lara-docs-kit ``` 2. Publish the tailwind css file. ``` php artisan vendor:publish --tag=lara-docs-kit-assets ``` 3. To enable the syntax highlighting the javascript package shiki is needed to be installed in the project. It can be install via npm: ``` npm install shiki ``` 4. A directory to store all the markdown files for the documentation will need to be created, using the default config the following command can be used to create the directory. ``` mkdir ./resources/docs ``` 5. A `nav.json` file will then be needed within that directory outlining the navigation menu. ``` { "introduction": "/", } ``` 6. That's it! You're now ready to start using lara-docs-kit for your Laravel documentation needs. Usage ----- [](#usage) The package is configured to run straight out the box, it adds a `/docs` route that takes markdown files directly out of the `/resources/docs` directory and deliveries them to the public. However, there is a config file that can be published and changed as needed. ### Configuration [](#configuration) To publish the configuration file using the following command: ``` php artisan vendor:publish --tag=lara-docs-kit-config ``` The configuration file located at `config/lara-docs-kit.php` can then be customised according to your project's requirements. Here is an example of a route. ``` 'routes' => [ [ 'name' => 'docs', 'url' => '/docs', 'dir' => 'docs/', 'middleware' => [ 'web', ], ], ], ``` ### Navigation [](#navigation) The package also uses a `nav.json` file in the top level of the directory that holds all the markdown files. This file allows for both top level links but also nested links (maximum of 1 level deep). ``` { "introduction": "/", "parent": { "introduction": "/parent/", "child": "/parent/child" } } ``` Contributing ------------ [](#contributing) If you find any issues or have suggestions to improve lara-docs-kit, we welcome contributions from the community. Please feel free to submit a pull request or open an issue. License ------- [](#license) lara-docs-kit is open-source software licensed under the [MIT license](./LICENSE). --- We hope lara-docs-kit proves to be a valuable tool for your Laravel projects. Should you have any questions or need assistance, don't hesitate to reach out to us on . Happy documenting! 😊 ### Health Score 22 — LowBetter than 22% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity3 Limited adoption so far Community7 Small or concentrated contributor base Maturity51 Maturing project, gaining track record Bus Factor1 Top contributor holds 100% 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 Unknown Total 1 Last Release 974d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/eb9fc78c7d359954860c95d4ed559107ba2f0b050e0aa412674a3eeeceb618d3?d=identicon)[JustinByrne](/maintainers/JustinByrne) --- Top Contributors [![JustinByrne](https://avatars.githubusercontent.com/u/14056930?v=4)](https://github.com/JustinByrne "JustinByrne (68 commits)") ### Code Quality TestsPest Code StylePHP CS Fixer ### Embed Badge ![Health badge](/badges/rex-devs-lara-docs-kit/health.svg) ``` [![Health](https://phpackages.com/badges/rex-devs-lara-docs-kit/health.svg)](https://phpackages.com/packages/rex-devs-lara-docs-kit) ``` ### Alternatives [ryangjchandler/orbit A flat-file database driver for Eloquent. 922256.2k5](/packages/ryangjchandler-orbit)[spatie/sheets Store & retrieve your static content in plain text files 30187.7k4](/packages/spatie-sheets)[dniccum/nova-documentation A Laravel Nova tool that allows you to add markdown-based documentation to your administrator's dashboard. 37116.4k](/packages/dniccum-nova-documentation)[genealabs/laravel-changelog A Laravel Nova tool. 55250.7k](/packages/genealabs-laravel-changelog)[hyde/framework The HydePHP Framework 3528.4k4](/packages/hyde-framework)[matildevoldsen/wire-comments A Livewire package for adding comments to your Laravel application. 401.0k](/packages/matildevoldsen-wire-comments) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)