https://github.com/riimu/sami-config

Automatic configuration provider for Sami documentation generator
https://github.com/riimu/sami-config

Last synced: about 2 months ago
JSON representation

Automatic configuration provider for Sami documentation generator

• Host: GitHub
• URL: https://github.com/riimu/sami-config
• Owner: Riimu
• License: mit
• Created: 2018-07-19T08:56:47.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2018-07-19T09:59:25.000Z (over 6 years ago)
• Last Synced: 2024-11-12T23:50:05.714Z (2 months ago)
• Language: PHP
• Size: 5.86 KB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Riimu's Automatic Sami Configuration #

I personally use [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://img.shields.io/travis/Riimu/sami-config.svg?style=flat-square)](https://travis-ci.org/Riimu/sami-config)

[![Packagist](https://img.shields.io/packagist/v/riimu/sami-config.svg?style=flat-square)](https://packagist.org/packages/riimu/sami-config)

## 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

```php