GremoCiconiaBundle
, (*1)
Symfony bundle for Ciconia Markdown parser for PHP., (*2)
Installation
Add the bundle in your composer.json
file:, (*3)
{
"require": {
"gremo/ciconia-bundle": "~1.0"
}
}
Then enable the bundle in the kernel:, (*4)
<?php
// app/AppKernel.php
public function registerBundles()
{
$bundles = array(
// ...
new Gremo\CiconiaBundle\GremoCiconiaBundle(),
// ...
);
}
Configuration
Configuration is optional, extensions are disabled by default:, (*5)
# GremoCiconiaBundle Configuration
gremo_ciconia:
renderer: ~ # Or null or "html" or "xhtml"
extensions: ~ # Enable all with true or null (false to disable)
To selectively enable an extension:, (*6)
# GremoCiconiaBundle Configuration
gremo_ciconia:
# ...
extensions:
fencedCodeBlock: ~ # Or true or null (false to disable)
# ...
Usage
Get the ciconia
service from the service container:, (*7)
/** @var \Ciconia\Ciconia $ciconia */
$ciconia = $container->get('ciconia');
// Refer to kzykhys/Ciconia for examples
$html = $ciconia->render('Markdown is **awesome**');
//
Markdown is awesome, (*8)
Or in twig template:, (*9)
{{ var|markdown }}
Give the service a tag named ciconia.extension
to automatically registered it as an extension., (*10)