PHPackages                             rgou/doc-renderer - 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. rgou/doc-renderer

ActiveSymfony-bundle

rgou/doc-renderer
=================

A Markdown/RestructuredText Renderer

v1.2.2(12y ago)7251MITPHPPHP >=5.3.2

Since Apr 3Pushed 12y ago2 watchersCompare

[ Source](https://github.com/rafaelgou/doc-renderer)[ Packagist](https://packagist.org/packages/rgou/doc-renderer)[ Docs](http://github.com/rafaelgou/doc-renderer)[ RSS](/packages/rgou-doc-renderer/feed)WikiDiscussions master Synced 2mo ago

READMEChangelogDependencies (5)Versions (9)Used By (0)

Doc Renderer
============

[](#doc-renderer)

Author: Rafael Goulart

Doc Renderer is a tool to render [Markdown](http://daringfireball.net/projects/markdown/)and [RestructuredText](http://docutils.sourceforge.net/rst.html) in PHP.

It uses [Twitter Bootstrap](http://twitter.github.com/bootstrap/) as CSS Framework, [Twig](http://twig.sensiolabs.org/) as template engine.

[Google Prettify](http://google-code-prettify.googlecode.com/svn/trunk/README.html) is used for syntax highlight.

DocRenderer is inspired by [RenderMarkdown](https://github.com/skurfer/RenderMarkdown), from which some functions were borrewed, thanks to [Rob McBroom](https://github.com/skurfer).

Screenshots
-----------

[](#screenshots)

[![renderer](https://camo.githubusercontent.com/490d19cbaaea1e38b903342e5e37c48780678e4ef5a7490bfba15d5a1ff3a474/68747470733a2f2f7261772e6769746875622e636f6d2f72616661656c676f752f646f632d72656e64657265722f6d61737465722f696d616765732f73637265656e73686f742d72656e64657265722e706e67 "The Renderer")](https://camo.githubusercontent.com/490d19cbaaea1e38b903342e5e37c48780678e4ef5a7490bfba15d5a1ff3a474/68747470733a2f2f7261772e6769746875622e636f6d2f72616661656c676f752f646f632d72656e64657265722f6d61737465722f696d616765732f73637265656e73686f742d72656e64657265722e706e67)

[![index](https://camo.githubusercontent.com/471e49f8fe1072151fcfb84366e7e33f12523b6d856637acf772fdcd7cb242e3/68747470733a2f2f7261772e6769746875622e636f6d2f72616661656c676f752f646f632d72656e64657265722f6d61737465722f696d616765732f73637265656e73686f742d696e6465782e706e67 "The Index")](https://camo.githubusercontent.com/471e49f8fe1072151fcfb84366e7e33f12523b6d856637acf772fdcd7cb242e3/68747470733a2f2f7261772e6769746875622e636f6d2f72616661656c676f752f646f632d72656e64657265722f6d61737465722f696d616765732f73637265656e73686f742d696e6465782e706e67)

Install
-------

[](#install)

Composer:

```
{
    "require": {
        // ...
        "rgou/doc-renderer": "*"
    }
}

```

Or clonning:

```
git clone git://github.com/rafaelgou/doc-renderer.git

```

Or just downloading lastest version:

```
wget https://github.com/rafaelgou/doc-renderer/archive/master.zip

```

For Restructured Text, Docutils is needed:

```
apt-get install python-docutils

```

Introduction
------------

[](#introduction)

The magic is:

- Some Markdown or Restructured Text
- For Markdown, [PHP-Markdown](https://github.com/michelf/php-markdown)
- For Restructured Text, [Docutils](http://docutils.sourceforge.net/rst.html)
- For rendering the HTML stuff, [Twig](http://twig.sensiolabs.org/)
- For a pretty good face, [Twitter Bootstrap](http://twitter.github.com/bootstrap/)(Bootstrap and JQuery are loaded from CDN sources)
- For syntax highlighting, [Google Prettify](http://google-code-prettify.googlecode.com/svn/trunk/README.html)
- For an easy configuration, [sfYaml](http://symfony.com/doc/current/components/yaml/introduction.html)

[Composer](getcomposer.org/) lets everything easier to glue togheter, and a basic example is just include the Composer autoloader, loads a configuration and uses the libraries togheter:

```