Download the PHP package m165437/laravel-blueprint-docs without Composer
On this page you can find all versions of the php package m165437/laravel-blueprint-docs. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package laravel-blueprint-docs
API Blueprint Renderer for Laravel
This Laravel package Blueprint Docs renders your API Blueprint. 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, this would be Blueprint Docs' output.
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.
Requirements
- Laravel 5.4 or greater
- Drafter (the official C++ API Blueprint parser) command line tool
- A valid API Blueprint
blueprint.apibin the root directory of your Laravel project (example available)
Drafter is not included and must be installed beforehand. Use the Drafter Installer composer package to "install drafter in your php project with ease". Head over there and install it now.
Installation
Install the package via composer:
Next, register its service provider (Laravel >= 5.5 does this automatically via Package Discovery):
Optionally, publish the example API Blueprint boilerplate file blueprint.apib to the root directory of your Laravel project:
Finally, publish its assets to public/vendor/blueprintdocs:
Find your documentation at route /api-documentation.
Update
When you update this package, you might need to republish its assets (note the added parameter --force):
Configuration
To adjust Blueprint Docs' configuration, publish its config file to config/blueprintdocs.php:
The default contents of the configuration file look like this:
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
To customize the default theme, publish its views to views/vendor/blueprintdocs:
Contributing
Thank you for considering contributing to this package! Please see CONTRIBUTING for details.
Credits
This package relies heavily on work done by Hendrik Maus, namely his Drafter PHP Wrapper and Reynaldo, it's inspired by Aglio, an API Blueprint renderer written in Node.js, and provides the API Blueprint boilerplate as an example. The header is the modified part of a graphic created by Iconicbestiary, via Freepik.com.
License
Blueprint Docs is licensed under the MIT License (MIT). Please see the LICENSE file for more information.
All versions of laravel-blueprint-docs with dependencies
laravel/framework Version >=5.4|~7.0
hmaus/drafter-php Version ^6.1.1
hmaus/reynaldo Version ^0.1.5
erusev/parsedown Version ^1.7.0
erusev/parsedown-extra Version ^0.7.1