PHPackages m165437/laravel-blueprint-docs - 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. [API Development](/categories/api) 4. / 5. m165437/laravel-blueprint-docs ActiveLibrary[API Development](/categories/api) m165437/laravel-blueprint-docs ============================== API Blueprint Renderer for Laravel v1.0.0(6y ago)22779.0k↓11.1%26[12 PRs](https://github.com/M165437/laravel-blueprint-docs/pulls)MITPHPPHP >=5.6.4 Since Sep 10Pushed 3y ago7 watchersCompare [ Source](https://github.com/M165437/laravel-blueprint-docs)[ Packagist](https://packagist.org/packages/m165437/laravel-blueprint-docs)[ Docs](https://github.com/M165437/laravel-blueprint-docs)[ RSS](/packages/m165437-laravel-blueprint-docs/feed)WikiDiscussions master Synced 1mo ago READMEChangelog (10)Dependencies (5)Versions (31)Used By (0) [![Blueprint Docs](https://camo.githubusercontent.com/c818a4fe18a36d10b0c0659cd1bdf12728b60fc8a4ddbf6bc332696d9e3b9c27/68747470733a2f2f692e696d6775722e636f6d2f6d364162626d632e706e67)](https://camo.githubusercontent.com/c818a4fe18a36d10b0c0659cd1bdf12728b60fc8a4ddbf6bc332696d9e3b9c27/68747470733a2f2f692e696d6775722e636f6d2f6d364162626d632e706e67) [![Latest Stable Version](https://camo.githubusercontent.com/20d05770722fa2fa694607d12eb8953b128ae692c4f1d2d12384703f8f7e1009/68747470733a2f2f706f7365722e707567782e6f72672f6d3136353433372f6c61726176656c2d626c75657072696e742d646f63732f762f737461626c65)](https://packagist.org/packages/m165437/laravel-blueprint-docs) [![Total Downloads](https://camo.githubusercontent.com/11c79ed2380c20584f5bb0fb83f9bd00ac703478570529f85c1038a5ab382d3f/68747470733a2f2f706f7365722e707567782e6f72672f6d3136353433372f6c61726176656c2d626c75657072696e742d646f63732f646f776e6c6f616473)](https://packagist.org/packages/m165437/laravel-blueprint-docs) [![Latest Unstable Version](https://camo.githubusercontent.com/8472585ba92efb8cc2f067b68e9f01d20930292414784cff61765f3f66fedf5b/68747470733a2f2f706f7365722e707567782e6f72672f6d3136353433372f6c61726176656c2d626c75657072696e742d646f63732f762f756e737461626c65)](https://packagist.org/packages/m165437/laravel-blueprint-docs) [![License](https://camo.githubusercontent.com/5c9e9a10d5fce5080f08a0a835a374f9d8ec580c679cc9bfe989cfbf6586f9c2/68747470733a2f2f706f7365722e707567782e6f72672f6d3136353433372f6c61726176656c2d626c75657072696e742d646f63732f6c6963656e7365)](https://packagist.org/packages/m165437/laravel-blueprint-docs) [![Twitter](https://camo.githubusercontent.com/235cc6cff5a92f58abb485840a86e5a3e19ebb8c89729fbb1b9b0b10b5a9e53b/68747470733a2f2f696d672e736869656c64732e696f2f62616467652f747769747465722d404d3136353433372d626c75652e7376673f7374796c653d666c617426636f6c6f72423d303061636564)](http://twitter.com/M165437) API Blueprint Renderer for Laravel ================================== [](#api-blueprint-renderer-for-laravel) This Laravel package *Blueprint Docs* renders your [API Blueprint](http://apiblueprint.org/). It comes with a standard theme that you can customize via Blade templates. Install the package and find your rendered documentation at route `/api-documentation`. **Example output**: If used with [API Blueprint boilerplate](https://github.com/jsynowiec/api-blueprint-boilerplate), this would be [*Blueprint Docs'* output](https://m165437.github.io/laravel-blueprint-docs). API Blueprint is a Markdown-based document format that lets you write API descriptions and documentation in a simple and straightforward way. Currently supported is [API Blueprint format 1A](https://github.com/apiaryio/api-blueprint/blob/master/API%20Blueprint%20Specification.md). Requirements ------------ [](#requirements) - Laravel 5.4 or greater - Drafter (the official C++ API Blueprint parser) [command line tool](https://github.com/apiaryio/drafter#drafter-command-line-tool) - A valid API Blueprint `blueprint.apib` in the root directory of your Laravel project (example available) **Drafter is not included** and must be installed beforehand. Use the [Drafter Installer](https://github.com/hendrikmaus/drafter-installer) composer package to "install drafter in your php project with ease". Head over there and install it now. Installation ------------ [](#installation) Install the package via composer: ``` composer require m165437/laravel-blueprint-docs ``` Next, register its service provider (Laravel >= 5.5 does this automatically via [Package Discovery](https://laravel.com/docs/5.5/packages#package-discovery)): ``` // config/app.php 'providers' => [ ... M165437\BlueprintDocs\BlueprintDocsServiceProvider::class, ]; ``` Optionally, publish the example [API Blueprint boilerplate](https://github.com/jsynowiec/api-blueprint-boilerplate) file `blueprint.apib` to the root directory of your Laravel project: ``` php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="example" ``` Finally, publish its assets to `public/vendor/blueprintdocs`: ``` php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="public" ``` Find your documentation at route `/api-documentation`. Update ------ [](#update) When you update this package, you might need to republish its assets (note the added parameter `--force`): ``` php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="public" --force ``` Configuration ------------- [](#configuration) To adjust Blueprint Docs' configuration, publish its config file to `config/blueprintdocs.php`: ``` php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="config" ``` The default contents of the configuration file look like this: ``` return [ /* |-------------------------------------------------------------------------- | Blueprint Docs |-------------------------------------------------------------------------- | | Find your rendered docs at the given route or set route to false if you | want to use your own route and controller. Provide a fully qualified | path to your API blueprint as well as to the required Drafter CLI. | */ 'route' => 'api-documentation', 'condense_navigation' => false, 'blueprint_file' => base_path('blueprint.apib'), 'drafter' => base_path('vendor/bin/drafter') ]; ``` If you want to use Blueprint Docs with your own route and controller, set `'route' => false` and have a look at `vendor/m165437/laravel-blueprint-docs/src/BlueprintDocsController.php` to get an idea on how to set it up. Theming ------- [](#theming) To customize the default theme, publish its views to `views/vendor/blueprintdocs`: ``` php artisan vendor:publish --provider="M165437\BlueprintDocs\BlueprintDocsServiceProvider" --tag="views" ``` Contributing ------------ [](#contributing) Thank you for considering contributing to this package! Please see [CONTRIBUTING](CONTRIBUTING.md) for details. Credits ------- [](#credits) This package relies heavily on work done by [Hendrik Maus](https://github.com/hendrikmaus), namely his [Drafter PHP Wrapper](https://github.com/hendrikmaus/drafter-php) and [Reynaldo](https://github.com/hendrikmaus/reynaldo), it's inspired by [Aglio](https://github.com/danielgtaylor/aglio), an API Blueprint renderer written in Node.js, and provides the [API Blueprint boilerplate](https://github.com/jsynowiec/api-blueprint-boilerplate) as an example. The header is the modified part of a [graphic created by Iconicbestiary](http://www.freepik.com/free-vector/hands-signing-house-or-apartment-contract_1311557.htm), via [Freepik.com](http://www.freepik.com). License ------- [](#license) Blueprint Docs is licensed under the MIT License (MIT). Please see the [LICENSE](LICENSE.md) file for more information. ### Health Score 43 — FairBetter than 91% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity47 Moderate usage in the ecosystem Community20 Small or concentrated contributor base Maturity69 Established project with proven stability Bus Factor1 Top contributor holds 58.5% 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 ~54 days Recently: every ~36 days Total 18 Last Release 2246d ago Major Versions v0.9.1 → v1.0.02020-03-24 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/711773?v=4)[Michael Schmidt-Voigt](/maintainers/m165437)[@M165437](https://github.com/M165437) --- Top Contributors [![M165437](https://avatars.githubusercontent.com/u/711773?v=4)](https://github.com/M165437 "M165437 (31 commits)")[![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)](https://github.com/dependabot[bot] "dependabot[bot] (19 commits)")[![backstageel](https://avatars.githubusercontent.com/u/1692858?v=4)](https://github.com/backstageel "backstageel (1 commits)")[![jeanroloff](https://avatars.githubusercontent.com/u/1781407?v=4)](https://github.com/jeanroloff "jeanroloff (1 commits)")[![trizz](https://avatars.githubusercontent.com/u/832056?v=4)](https://github.com/trizz "trizz (1 commits)") --- Tags apilaravelrendererdocsblueprint ### Embed Badge ![Health badge](/badges/m165437-laravel-blueprint-docs/health.svg) ``` [![Health](https://phpackages.com/badges/m165437-laravel-blueprint-docs/health.svg)](https://phpackages.com/packages/m165437-laravel-blueprint-docs) ``` ### Alternatives [binarytorch/larecipe Generate gorgeous recipes for your Laravel applications using MarkDown 2.5k2.7M16](/packages/binarytorch-larecipe)[dingo/blueprint API Blueprint documentation generator. 2707.8M22](/packages/dingo-blueprint)[johnylemon/laravel-apidocs Laravel API documentation generating tool 472.8k](/packages/johnylemon-laravel-apidocs)[yaro/apidocs Api documentation generator for Laravel 5 114.1k](/packages/yaro-apidocs) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)