Download the PHP package rgou/doc-renderer without Composer

On this page you can find all versions of the php package rgou/doc-renderer. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

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 PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • 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.
Please rate this library. Is it a good library?

Example code of rgou/doc-renderer

Informations about the package doc-renderer

Doc Renderer

Author: Rafael Goulart [email protected]

Doc Renderer is a tool to render Markdown and RestructuredText in PHP.

It uses Twitter Bootstrap as CSS Framework, Twig as template engine.

Google Prettify is used for syntax highlight.

DocRenderer is inspired by RenderMarkdown, from which some functions were borrewed, thanks to Rob McBroom.

Screenshots

renderer

index

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

The magic is:

Composer lets everything easier to glue togheter, and a basic example is just include the Composer autoloader, loads a configuration and uses the libraries togheter:

~~~

Customizing the template

Twitter Bootstrap

Change in the <head>

<link href="//netdna.bootstrapcdn.com/twitter-bootstrap/2.3.1/css/bootstrap-combined.min.css" rel="stylesheet">

to whatever other theme you want. See Bootstrap CDN for more free options.

Google Prettify:

You can add languages not supported by default adding lines just like bellow on bottom of the page (just before </body>):

<script src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script>
<script src="https://google-code-prettify.googlecode.com/svn/loader/lang-yaml.js"></script>

Additional languages are list here.

You can also change the skin on <head>

<link href="//google-code-prettify.googlecode.com/svn/loader/skins/desert.css" rel="stylesheet">

See available skins here.

All versions of doc-renderer with dependencies

PHP Build Version
Package Version
Requires php Version >=5.3.2
symfony/yaml Version 2.2.*@dev
twig/twig Version 1.*
twig/extensions Version 1.0.*
michelf/php-markdown Version 1.3.*@dev
aptoma/twig-markdown Version dev-master
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package rgou/doc-renderer contains the following files

Loading the files please wait ....