sugared-rim / sami
Sami sweetened with ease
0.5.0
2017-05-22 18:59 UTC
Requires
- php: >=7
- sami/sami: ^4.0
- schnittstabil/composer-extra: ^2.0
- schnittstabil/get: ^2.0
Requires (Dev)
- sugared-rim/phpunit: ^6.0
- symfony/event-dispatcher: ^3.1
This package is not auto-updated.
Last update: 2024-10-27 03:06:27 UTC
README
Sami sweetened with ease 🍒
SugaredRim\Sami takes an opinionated view of generating documentation with Sami, it is preconfigured to get you up and running as quickly as possible.
Install
$ composer require --dev sugared-rim/sami
Usage
Instead of creating a configuration file and running sami.phar update /path/to/config.php
, just run sugared-rim-sami
- that's it:
{ ... "require-dev": { "sugared-rim/sami": ... }, "scripts": { "doc": "sugared-rim-sami" } }
Configuration
You may overwrite some options by putting it in your composer.json
.
Some of the default settings:
{ ... "scripts": { "doc": "sugared-rim-sami" }, "extra": { "sugared-rim/sami": { "files": "src", "filter": "SugaredRim\\Sami\\ProtectedFilter", "build_dir": "build/sami", "cache_dir": "build/cache/sami" } } }
All extra.sugared-rim/sami
options are passed through the Sami constructor, except:
filter
: A FQCN of the filter to use,sugared-rim-sami
will create an instance for you.
License
MIT © Michael Mayer