PHPackages                             riimu/sami-config - 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. riimu/sami-config

ActiveLibrary[API Development](/categories/api)

riimu/sami-config
=================

Automatic configuration provider for Sami documentation generator

v0.1.0(7y ago)01124MITPHPPHP ^7.1

Since Jul 19Pushed 7y agoCompare

[ Source](https://github.com/Riimu/sami-config)[ Packagist](https://packagist.org/packages/riimu/sami-config)[ RSS](/packages/riimu-sami-config/feed)WikiDiscussions master Synced yesterday

READMEChangelog (1)Dependencies (2)Versions (2)Used By (4)

Riimu's Automatic Sami Configuration
====================================

[](#riimus-automatic-sami-configuration)

I personally use [Sami](https://github.com/FriendsOfPHP/Sami) for generating API documentation for number of my projects. However, to generate that documentation, I need to set up a configuration for each project that only varies slightly per project. Thus I created this composer package that can automatically figure out the configuration and set it up properly for each project.

Essentially, by using this automatic configuration utility, you can have Sami configured with some defaults that are figured from rest of the project files rather than having to manually duplicate them into the Sami config.

[![Travis](https://camo.githubusercontent.com/4910de8ad3db0ef754f4836e0a417e1154ff1d1c0735fc9c6f6c3849b50e55b2/68747470733a2f2f696d672e736869656c64732e696f2f7472617669732f5269696d752f73616d692d636f6e6669672e7376673f7374796c653d666c61742d737175617265)](https://travis-ci.org/Riimu/sami-config)[![Packagist](https://camo.githubusercontent.com/0e528a24c6eccaa18e45482e6e282985086bc37169e4ce7a851f89cf1112f6aa/68747470733a2f2f696d672e736869656c64732e696f2f7061636b61676973742f762f7269696d752f73616d692d636f6e6669672e7376673f7374796c653d666c61742d737175617265)](https://packagist.org/packages/riimu/sami-config)

Usage
-----

[](#usage)

To add this configuration utility to your project, you should first include it via composer:

```
$ composer require --dev riimu/sami-config

```

Then you should create a file named `sami_config.php` in your project root directory that simply contains

```