mimiz/silex-documentation-provider

Add documentation for your project

Silex Documentation Provider

, _(*1)

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., _(*2)

NOTE : This is still in development and there's no stable release ..., _(*3)

Installation

Install the silex-documentation-provider using composer. This project uses sematic versioning., _(*4)

{
    "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), Markdown, or plain text., _(*5)

So if you want to use Markdown Syntax, you will need to add the Markdown Dependency in your composer.json file, _(*6)

{
    "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), _(*7)

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

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

• documentation.dir, _(*8)

  Path to the directory that contains your documentation files, _(*9)

• documentation.url, _(*10)

  The base URL of your documentation, _(*11)

• documentation.extension, _(*12)

  The file extension you used for documentation files, _(*13)

• documentation.home, _(*14)

  The name of the Home page, this will be used for each subdirectories, _(*15)

• documentation.syntax, _(*16)

  The syntax you want to use Available : markdown,textile, plain, _(*17)

• documentation.title, _(*18)

  The title of the documentation Page (only for HTML Renderers like textile or markdown), _(*19)

• documentation.styles, _(*20)

  An array of css urls to add to your documentations, _(*21)

  array('/components/bootstrap/css/bootstrap.min.css')
  

• documentation.scripts, _(*22)

  An array of js urls to add to your documentations, _(*23)

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

License

This software is licensed under MIT, _(*24)