mimiz/silex-documentation-provider

Add documentation for your project

0.0.1 2013-07-28 19:14 UTC

Requires

• silex/silex: ~1.1.0

Requires (Dev)

• michelf/php-markdown: 1.3.x-dev
• netcarver/textile: v3.5.1
• phpunit/phpunit: 3.7.*
• symfony/browser-kit: 2.3.*
• symfony/css-selector: 2.3.x-dev

MIT

• Rémi Goyard

README

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

Install the silex-documentation-provider using composer. This project uses sematic versioning.

{
    "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.

So if you want to use Markdown Syntax, you will need to add the 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)

{
    "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

  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

This software is licensed under MIT