PHPackages                             mimiz/silex-documentation-provider - 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. [Utility & Helpers](/categories/utility)
4. /
5. mimiz/silex-documentation-provider

ActiveLibrary[Utility & Helpers](/categories/utility)

mimiz/silex-documentation-provider
==================================

Add documentation for your project

0.0.1(12y ago)017MITPHP

Since Jul 28Pushed 12y ago1 watchersCompare

[ Source](https://github.com/mimiz/silex-documentation-provider)[ Packagist](https://packagist.org/packages/mimiz/silex-documentation-provider)[ RSS](/packages/mimiz-silex-documentation-provider/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (6)Versions (2)Used By (0)

Silex Documentation Provider
============================

[](#silex-documentation-provider)

[![Build Status](https://camo.githubusercontent.com/8921173cb242ab45a4d01f7f84f8fab0b244581d2ea701fe9d0fc17565a85cf7/68747470733a2f2f7472617669732d63692e6f72672f6d696d697a2f73696c65782d646f63756d656e746174696f6e2d70726f76696465722e706e67)](https://travis-ci.org/mimiz/silex-documentation-provider)

This Provider allows you to create a project documentation folder where you will be able to write all the documentation needed for developpers, for example describe the .htaccess file, or describe the directory structure, or even some development rules.

**NOTE** : This is still in development and there's no stable release ...

Installation
------------

[](#installation)

Install the silex-documentation-provider using [composer](http://getcomposer.org/). This project uses [sematic versioning](http://semver.org/).

```
{
    "require": {
        "mimiz/silex-documention-provider": "~0.0.1"
    }
}
```

Then you'll need to choose a renderer, currently this support : \[Textile\]([http://en.wikipedia.org/wiki/Textile\_(markup\_language)](http://en.wikipedia.org/wiki/Textile_(markup_language)), [Markdown](http://en.wikipedia.org/wiki/Markdown), or plain text.

So if you want to use [Markdown](http://en.wikipedia.org/wiki/Markdown) Syntax, you will need to add the [Markdown](http://en.wikipedia.org/wiki/Markdown) Dependency in your **composer.json** file

```
{
    "require": {
        "mimiz/silex-documention-provider": "~0.0.1",
        "michelf/php-markdown": "1.3"
    }
}
```

And here is the **composer.json** file if you want to use \[Textile\]([http://en.wikipedia.org/wiki/Textile\_(markup\_language)](http://en.wikipedia.org/wiki/Textile_(markup_language))

```
{
    "require": {
        "mimiz/silex-documention-provider": "~0.0.1",
        "netcarver/textile": "v3.5.1"
    }
}
```

Usage
-----

[](#usage)

```
$app->register(new \Mimiz\Silex\Provider\DocumentationProvider(), array(
    "documentation.dir" => __DIR__."/../documentation",
    "documentation.url" => '/doc',
    "documentation.extension" => 'md',
    "documentation.home"=>'index',
    "documentation.syntax"=>'markdown',
    "documentation.title"=>'My Documentation',
    "documentation.styles" => array('/components/bootstrap/css/bootstrap.min.css'),
    "documentation.scripts" => array('/components/jquery/jquery.min.js','/components/bootstrap/js/bootstrap.min.js')
));
```

### Parameters

[](#parameters)

- **documentation.dir**

    > Path to the directory that contains your documentation files
- **documentation.url**

    > The base URL of your documentation
- **documentation.extension**

    > The file extension you used for documentation files
- **documentation.home**

    > The name of the Home page, this will be used for each subdirectories
- **documentation.syntax**

    > The syntax you want to use Available : markdown,textile, plain
- **documentation.title**

    > The title of the documentation Page (only for HTML Renderers like textile or markdown)
- **documentation.styles**

    > An array of css urls to add to your documentations

    ```
    array('/components/bootstrap/css/bootstrap.min.css')
    ```
- **documentation.scripts**

    > An array of js urls to add to your documentations

    ```
    array('/components/jsquery/jquery.min.js', '/components/bootstrap/js/bootstrap.min.js')
    ```

License
-------

[](#license)

This software is licensed under [MIT](http://rgoyard.mit-license.org/)

###  Health Score

23

—

LowBetter than 27% of packages

Maintenance20

Infrequent updates — may be unmaintained

Popularity6

Limited adoption so far

Community4

Small or concentrated contributor base

Maturity53

Maturing project, gaining track record

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

Unknown

Total

1

Last Release

4671d ago

### Community

Maintainers

![](https://www.gravatar.com/avatar/caa839a88ba9d485eec370ff8e020c314f10fb2e4ddedb3424a4bf92198259b2?d=identicon)[mimiz](/maintainers/mimiz)

###  Code Quality

TestsPHPUnit

### Embed Badge

![Health badge](/badges/mimiz-silex-documentation-provider/health.svg)

```
[![Health](https://phpackages.com/badges/mimiz-silex-documentation-provider/health.svg)](https://phpackages.com/packages/mimiz-silex-documentation-provider)
```

###  Alternatives

[igorw/config-service-provider

A config ServiceProvider for Silex with support for php, json and yaml.

215636.5k13](/packages/igorw-config-service-provider)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)