Download the PHP package mimiz/silex-documentation-provider without Composer
On this page you can find all versions of the php package mimiz/silex-documentation-provider. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download mimiz/silex-documentation-provider
More information about mimiz/silex-documentation-provider
Files in mimiz/silex-documentation-provider
Package silex-documentation-provider
Short Description Add documentation for your project
License MIT
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package silex-documentation-provider
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
Install the silex-documentation-provider using composer. This project uses sematic versioning.
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
And here is the composer.json file if you want to use [Textile](http://en.wikipedia.org/wiki/Textile_(markup_language)
Usage
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
- documentation.scripts
An array of js urls to add to your documentations
License
This software is licensed under MIT
