PHP code example of rgou / doc-renderer

1. Go to this page and download the library: Download rgou/doc-renderer library. Choose the download type require.

2. Extract the ZIP file and open the index.php.

3. Add this code to the index.php.

    
        
<?php
require_once('vendor/autoload.php');

/* Start to develop here. Best regards https://php-download.com/ */

rgou / doc-renderer example snippets


    // File examples/basic.php
    
    onfig
    $yaml               = new \Symfony\Component\Yaml\Parser();
    $configFile         = file_get_contents(__DIR__ . '/basic.yml');
    $data               = $yaml->parse($configFile);

    // Loading Twig
    $loader = new Twig_Loader_Filesystem(__DIR__ . '/../Resources/views');
    $twig   = new Twig_Environment($loader);

    // Optional - just for showing sources for your information

    $data['mdFileName']  = 'basic.md';
    $data['mdSource']    = file_get_contents(__DIR__ . DIRECTORY_SEPARATOR . $data['mdFileName']);

    $data['phpFileName'] = ('basic.php');
    $data['phpSource']   = highlight_file (__FILE__, true);

    $data['configFile'] = $configFile;

    // Extension Twig Markdown
    $parser = new \dflydev\markdown\MarkdownParser();
    $twig->addExtension(new \Aptoma\Twig\Extension\MarkdownExtension($parser));

    // Rendering Twig
    $template = $twig->loadTemplate('examples/basic.html.twig');
    $template->display($data);

The above file uses this sample YML file:

    # File examples/basic.yml
    title: Basic

loads this Markdown file:

    # examples/basic.md
    #Basic Sample

    Paragraph of text.

and renders with this twig template:

    <!-- File Resources/views/examples/basic.html.twig -->
    <!DOCTYPE html>
    <html lang="en">
    <head>
        <meta charset="utf-8">
        <title>Markdown Renderer - {{ title }}</title>
        <meta name="viewport" content="width=device-width, initial-scale=1.0">
        <meta name="description" content="">
        <meta name="author" content="">

        <!-- Le styles -->
        <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-combined.min.css" rel="stylesheet">
        <style>
            body { padding-top: 60px; /* 60px to make the container go all the way to the bottom of the topbar */ }
            .footer { text-align: center; padding: 20px 0; margin-top: 40px; border-top: 1px solid #e5e5e5; background-color: #f5f5f5; }
            .footer p { margin-bottom: 0; color: #777; }
        </style>
        <link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-responsive.min.css" rel="stylesheet">

    </head>

    <body>

        <div class="navbar navbar-inverse navbar-fixed-top">
        <div class="navbar-inner">
            <div class="container">
            <button type="button" class="btn btn-navbar" data-toggle="collapse" data-target=".nav-collapse">
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
            </button>
            <a class="brand" href="#">{{ title }}</a>
            <div class="nav-collapse collapse">
                <ul class="nav">
                <li class="active"><a href="index.php">Index of Examples</a></li>
                <li><a href="">About Markdown Basic</a></li>
                </ul>
            </div><!--/.nav-collapse -->
            </div>
        </div>
        </div>

        <div class="container">

    {% markdown %}{{ mdSource }}{% endmarkdown %}

    <hr />

    <h4>Markdown Source "{{ mdFileName }}"</h4>

    <pre>
    {{ mdSource }}
    </pre>

    <hr />

    <h4>PHP Source "{{ phpFileName }}"</h4>

    {{ phpSource | raw }}

        </div> <!-- /container -->

        <footer class="footer">
            <div class="container">
                <p><a href="http://github.com/rafaelgou/markdown-renderer" target="_blank">Markdown Renderer</a> &copy; <a href="http://tech.rgou.net" target="_blank">Rafael Goulart</a> 2013</p>
            </div>                
        </footer>

        <!-- Javascript CDN -->
        <script src="http://code.jquery.com/jquery-1.9.1.min.js"></script>
        <script src="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/js/bootstrap.min.js"></script>

    </body>
    </html>

As you can see, is just everything glued together. But there's something more interesting below.


Rendering a full directory
--------------------------

On the examples directory, there are three directories:

- auto (for both markdow and rst files)
- auto_markdown
- auto_rst

Any of them can transform a directory with `.md` or `.rst` into a
browseable directory of docs.

How to use:

- Copy any of these directories to a Apache+PHP directory, renaming if you want to;

- Point both PHP files to the right doc-renderer directory:
  `$docRendererPath = __DIR__ . '/../doc-renderer'; // Change here!`

- Be sure the Apache directive `AllowOverride All` is set for this directory!

- Put some Markdown or Restructured Text on this folder (even subdirectories)

- Open in the browser

The `index.php` searchs for all related files (see `.htaccess` file for more info)
and `autorender*.php` do the magic.

Markdown
--------

DocRenderer uses [PHP-Markdown-Extra](http://michelf.ca/projects/php-markdown/extra/) by default.

This makes easier to use syntax highlighting as you can pass the language you want:

    ~~~ .php
     
        echo 'foo';
        $var = array('test' => 123);
        print_r($var);