PHPackages reliqarts/laravel-docweaver - 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. [Parsing & Serialization](/categories/parsing) 4. / 5. reliqarts/laravel-docweaver ActiveLibrary[Parsing & Serialization](/categories/parsing) reliqarts/laravel-docweaver =========================== An easy-to-use product documentation package for Laravel. v5.1.1(2y ago)444532MITPHPPHP ^8.1CI failing Since Oct 4Pushed 2y ago2 watchersCompare [ Source](https://github.com/reliqarts/laravel-docweaver)[ Packagist](https://packagist.org/packages/reliqarts/laravel-docweaver)[ GitHub Sponsors](https://github.com/reliq)[ RSS](/packages/reliqarts-laravel-docweaver/feed)WikiDiscussions main Synced yesterday READMEChangelog (10)Dependencies (13)Versions (38)Used By (0) Laravel Docweaver ================= [](#laravel-docweaver) An easy-to-use product documentation package for Laravel. Docweaver is suitable for product documentation and/or knowledge bases. Converts folder(s) of .md files into full-bread complete documentation. Docweaver is inspired by Laravel's very own documentation. [![Built For Laravel](https://camo.githubusercontent.com/5eeeef36666bf2aefe6800cfd097832e37f96e2d2f2b944baf4744637b05c4c9/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f6275696c74253230666f722d6c61726176656c2d7265642e7376673f7374796c653d666c61742d737175617265)](http://laravel.com)[![Build Status (all)](https://camo.githubusercontent.com/f58111b7bfe1d159aa5e6941476c97228c1cd0a634decf5615ac5b79673e9646/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f636f6d2f72656c6971617274732f6c61726176656c2d646f637765617665723f7374796c653d666c61742d737175617265)](https://travis-ci.com/reliqarts/laravel-docweaver)[![Scrutinizer](https://camo.githubusercontent.com/3fd4b13a74cc04c6ebe81c844a78e79e245e24659936fe365e7666be87bab287/68747470733a2f2f696d672e736869656c64732e696f2f7363727574696e697a65722f672f72656c6971617274732f6c61726176656c2d646f637765617665722e7376673f7374796c653d666c61742d737175617265)](https://scrutinizer-ci.com/g/reliqarts/laravel-docweaver/)[![Codecov](https://camo.githubusercontent.com/9d1094caf1c6b4b3334c3542125341c95cdd7911dcfeb7beb211c7c90f0ee03f/68747470733a2f2f696d672e736869656c64732e696f2f636f6465636f762f632f6769746875622f72656c6971617274732f6c61726176656c2d646f637765617665722e7376673f7374796c653d666c61742d737175617265)](https://codecov.io/gh/reliqarts/laravel-docweaver)[![Maintainability](https://camo.githubusercontent.com/25d668ba45ed6ea2b6fde1541a05f1b877e630e6d075d4b60d13662ad6b538fa/68747470733a2f2f6170692e636f6465636c696d6174652e636f6d2f76312f6261646765732f39633466663331363937376562613732353663362f6d61696e7461696e6162696c697479)](https://codeclimate.com/github/reliqarts/laravel-docweaver/maintainability)[![License](https://camo.githubusercontent.com/2448af188e21ef72e4efd09d781b9ad1eede053a874d70229f54ddc1b029e493/68747470733a2f2f706f7365722e707567782e6f72672f72656c6971617274732f6c61726176656c2d646f637765617665722f6c6963656e73653f666f726d61743d666c61742d737175617265)](https://packagist.org/packages/reliqarts/laravel-docweaver)[![Latest Stable Version](https://camo.githubusercontent.com/f5c8173e3465b0854ba61f52b36bf76a38626e82a535e5529d5484611b876451/68747470733a2f2f706f7365722e707567782e6f72672f72656c6971617274732f6c61726176656c2d646f637765617665722f76657273696f6e3f666f726d61743d666c61742d737175617265)](https://packagist.org/packages/reliqarts/laravel-docweaver)[![Latest Unstable Version](https://camo.githubusercontent.com/c243242315f44c76aac8bb162e11ff874738bfb58ee3f5e9833a5a770ba1d438/68747470733a2f2f706f7365722e707567782e6f72672f72656c6971617274732f6c61726176656c2d646f637765617665722f762f756e737461626c653f666f726d61743d666c61742d737175617265)](//packagist.org/packages/reliqarts/laravel-docweaver)[![check it out!](https://camo.githubusercontent.com/539f122f2eb6a061bd6935bec6bf91db6daa9ff89021dbc7c167f13880184364/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f726561642d746865253230646f63732d626c75652e7376673f7374796c653d666c61742d737175617265)](http://docweaver.reliqarts.com) Key Features ------------ [](#key-features) Docweaver provides the following features and more out of the box. - Multi-product support - Docweaver supports multiple products out-the-box. Just create your product folders and drop in your documentation version directories. - Plug and play - Just install and configure and you're golden! *(approx. 2min)* Installation & Usage ------------------------ [](#installation--usage) ### Installation [](#installation) Install via composer; in console: ``` composer require reliqarts/laravel-docweaver ``` or require in *composer.json*: ``` { "require": { "reliqarts/laravel-docweaver": "^2.0" } } ``` then run `composer update` in your terminal to pull it in. Once this has finished, you will need to add the service provider to the providers array in your app.php config as follows: *(n.b. This package supports Laravel's package auto-discovery; if you are using Laravel 5.5 or above you can skip this step.)* ``` ReliqArts\Docweaver\ServiceProvider::class, ``` Ensure that your applications public storage directory is linked and accessible via the browser. ``` php artisan storage:link ``` see: Finally, publish package resources and configuration: ``` php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider" ``` You may opt to publish only configuration by using the `docweaver-config` tag: ``` php artisan vendor:publish --provider="ReliqArts\Docweaver\ServiceProvider" --tag="docweaver-config" ``` ### Setup [](#setup) Set the desired environment variables so the package knows your image model, controller(s), etc. Example environment config: ``` DOCWEAVER_ROUTE_PREFIX=docs DOCWEAVER_DIR=resources/docs ``` These variables, and more are explained within the [config](https://github.com/ReliqArts/laravel-docweaver/blob/main/src/config/config.php) file. ### Documentation Directory [](#documentation-directory) The documentation directory is the place where you put your project documentation directories. It may be changed with the config key `docweaver.storage.dir` or the environment variable `DOCWEAVER_DIR`. The default documentation directory is `resources/docs`. #### Structure [](#structure) Each project directory should contain separate folders for each documented version. Each version must have at least two (2) markdown files, namely `documentation.md` and `installation.md`, which serve as the sidebar and initial documentation pages respectively. ``` [doc dir] │ └─── Project One │ └── 1.0 │ └── 2.1 │ └── .docweaver.yml # meta file (optional) │ └── documentation.md # sidebar nav │ └── installation.md # initial page │ └─── Project Two ``` #### Meta File [](#meta-file) Configurations for each doc version may be placed in `.docweaver.yml`. The supported settings are: - #### name [](#name) Product name. - #### description [](#description) Product description. - #### image\_url [](#image_url) Product image url. This may be an absolute url (e.g. `http://mywebsite.com/myimage.jpg`) or an image found in the `images` resource directory. To use the `foo.jpg` in the images directory you would set `image_url` to `{{docs}}/images/foo.jpg`. For more info. see: [Assets](/docs/%7B%7Bversion%7D%7D/assets) --- ### Acknowledgements [](#acknowledgements) This package was inspired by Laravel's [documentation](https://github.com/laravel/laravel) and uses its underlying mechanism as a base. ### Health Score 39 — LowBetter than 86% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity24 Limited adoption so far Community11 Small or concentrated contributor base Maturity84 Battle-tested with a long release history Bus Factor1 Top contributor holds 97.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 ~65 days Recently: every ~317 days Total 37 Last Release 800d ago Major Versions v1.4.1 → v2.0.0-beta2019-03-15 2.x-dev → v3.0.0-beta2019-12-21 v3.1.0 → v4.0.02020-09-12 v4.1.0 → v5.0.02022-02-28 PHP version history (5 changes)v1.0.0-betaPHP >=5.6.4 v1.4.0PHP >=7.1.3 v3.0.0-betaPHP ^7.4 v4.1.0PHP ^7.4 || ^8.0 v5.1.0PHP ^8.1 ### Community Maintainers ![](https://www.gravatar.com/avatar/b6fe8ddd9e024531dab6ec959ec29afc5cca84bb2129dc5405ff8f443bb19672?d=identicon)[Reliq](/maintainers/Reliq) --- Top Contributors [![reliq](https://avatars.githubusercontent.com/u/2624812?v=4)](https://github.com/reliq "reliq (169 commits)")[![snyk-bot](https://avatars.githubusercontent.com/u/19733683?v=4)](https://github.com/snyk-bot "snyk-bot (4 commits)") --- Tags documentationgeneratorlaravellaravel-5-packagelaravel-6-packagelaravel-docweavermarkdownorganizerproductreadmelaravelpackagedocumentationdoccontentgeneration ### Code Quality TestsPHPUnit Code StyleECS ### Embed Badge ![Health badge](/badges/reliqarts-laravel-docweaver/health.svg) ``` [![Health](https://phpackages.com/badges/reliqarts-laravel-docweaver/health.svg)](https://phpackages.com/packages/reliqarts-laravel-docweaver) ``` ### Alternatives [laravel/framework The Laravel Framework. 34.6k509.9M17.0k](/packages/laravel-framework)[tightenco/jigsaw Simple static sites with Laravel's Blade. 2.2k438.5k29](/packages/tightenco-jigsaw)[reliqarts/laravel-scavenger The most integrated web scraper package for Laravel. 1571.5k](/packages/reliqarts-laravel-scavenger)[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)[grazulex/laravel-atlas Laravel Atlas scans your Laravel project to generate a complete, structured map of its internal components — models, controllers, routes, jobs, observers, events, commands, and more — and exports visual or machine-readable representations in formats like Mermaid, Markdown, JSON, or PDF. 161.7k](/packages/grazulex-laravel-atlas) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)