Weave Code
Laravel Docweaver Laravel Package
reliqarts/laravel-docweaver
Reliq Arts' Laravel DocWeaver lets you build and publish project documentation directly inside Laravel. It renders Markdown docs through configurable routes, making it easy to organize, browse, and share guides, API references, and manuals without maintaining a separate docs site.
Product documentation generation package for Laravel.
Frequently asked questions about Laravel Docweaver
- How do I install reliqarts/laravel-docweaver?
- Install it with Composer using composer require reliqarts/laravel-docweaver. Laravel package auto-discovery registers the service provider, then you publish the package config and set your documentation path and routes. Choose the package constraint that matches your Laravel version, for example ^5.1 on Laravel 9 or 10 and a pinned 5.0.x release on Laravel 8.
- Which Laravel versions does laravel-docweaver support?
- Release 5.1.0 adds Laravel 10 support and drops Laravel 8, so Laravel 9 and 10 are the intended targets. Laravel 8 projects should stay on the last 5.0.x release and treat that branch as unsupported unless the maintainer publishes a security branch. Confirm the actual illuminate/support constraint in composer.json before relying on any support claim.
- Does laravel-docweaver require PHP 8.1?
- The package itself has historically been a standard Laravel library, but 5.1.0 supports Laravel 10, which requires PHP 8.1 or newer. That means the effective PHP floor for Laravel 10 users is 8.1 even if the package does not add its own stricter constraint. Check composer.json for the exact php requirement before upgrading.
- Why did Composer install laravel-docweaver 5.1.0 on my Laravel 8 app?
- The 5.1.0 release dropped Laravel 8 but shipped as a minor version, and a ^5.0 constraint will admit it. That can let composer update pull an incompatible release into a Laravel 8 codebase without a human decision. Pin Laravel 8 consumers to ^5.0 with an explicit upper bound or the exact last 5.0.x version, and verify whether the Laravel 8 drop is a hard Composer conflict.
- How do I configure documentation routes in laravel-docweaver?
- Publish the package configuration file and define the route prefix, middleware, and documentation directory used to serve your Markdown files. DocWeaver renders Markdown docs through those configurable routes so guides, API references, and manuals can live inside the Laravel app. After upgrading, re-publish and diff the config in case defaults changed alongside the platform support bump.
- Can laravel-docweaver render Markdown API references and manuals?
- Yes. DocWeaver is built to render Markdown documentation through Laravel routes, so you can organize guides, API references, and manuals without maintaining a separate docs site. You control where docs are stored and how routes are exposed, which lets you fit documentation into your existing Laravel application.
- Is laravel-docweaver suitable for production documentation?
- It is a standard Composer-distributed Laravel library, so production suitability depends mostly on version pinning and support status. Use ^5.1 on Laravel 9 or 10 after confirming Laravel 9 is still tested, and pin Laravel 8 applications to a known 5.0.x release. For regulated environments, treat the Laravel 8 support gap as a compliance exposure because upstream Laravel 8 security patches are no longer available.
- What are alternatives to laravel-docweaver?
- Alternatives include dedicated static documentation generators, hosted documentation platforms, or custom Laravel routes that render Markdown with your own renderer. Evaluate them on Laravel version support, maintenance activity, route and auth integration, and whether you need docs to live inside the application. If you want in-app docs with minimal extra infrastructure, DocWeaver remains a direct fit on supported Laravel versions.
- How do I upgrade laravel-docweaver from 5.0.x to 5.1.0?
- On Laravel 9 or 10, update the Composer constraint to ^5.1, run composer update, re-publish and diff the config, and run your integration tests. Laravel 8 applications cannot consume 5.1.0, so they must either pin to 5.0.x or complete a sequential Laravel 8 to 9 to 10 framework upgrade first. Only bump the package after the framework upgrade lands so failures are attributable.
- Is laravel-docweaver 5.1.0 a breaking change?
- Dropping Laravel 8 is a breaking change to the install contract, even though 5.1.0 was published as a minor release. A ^5.0 constraint can therefore admit 5.1.0 on Laravel 8 projects, creating dependency resolution or untested runtime risk. Raise this with the maintainer and ask for a corrected major release or a 5.0.x security branch with a stated EOL date.
Weaver
How can I help you explore Laravel packages today?