Graph-IT DocDisplay

The graphit/doc-display silex web application renders markdown files from its var directory.

The application creates an index over all index.md files found at var/<company>/<project>/index.md and serves the layouted and to HTML converted markdown files. The intended use is to display markdown files provided by graphit/doc-collect.

Installation

composer create-project graphit/doc-display

Usage

You can start to customize the application by running it with the PHPs built-in web server:

php -S localhost:8000 -t web

For production use the application should be run by apache2 or nginx.

To test the application create a file test-company/test-project/index.md in the var directory with the following content:

#Test

Point your webbrowser at http://localhost:8080 and the project test-company/test-project should be listed.

Customisation

You can customize the layout and the index and markdown pages by overriding the twig templates layout-default.html.twig, index-default.html.twig and page-default.html.twig in the views directory with templates layout-custom.html.twig, index-custom.html.twig and page-custom.html.twig.