gremo / ciconia-bundle

该包已被 废弃 并不再维护。未建议替换包。

Symfony 组件,用于 PHP 的 Ciconia Markdown 解析器

安装: 955

依赖者: 0

建议者: 0

安全: 0

星标: 1

关注者: 2

分支: 0

开放问题: 0

类型:symfony-bundle

v1.0.1 2015-03-06 18:18 UTC

This package is auto-updated.

Last update: 2020-07-04 15:30:36 UTC


README

Latest stable Downloads total GitHub issues

Symfony 组件,用于 PHP 的 Ciconia Markdown 解析器。

安装

在您的 composer.json 文件中添加该组件

{
    "require": {
        "gremo/ciconia-bundle": "~1.0"
    }
}

然后在内核中启用该组件

<?php
// app/AppKernel.php

public function registerBundles()
{
    $bundles = array(
        // ...
        new Gremo\CiconiaBundle\GremoCiconiaBundle(),
        // ...
    );
}

配置

配置是可选的,默认情况下 扩展被禁用

# GremoCiconiaBundle Configuration
gremo_ciconia:
    renderer: ~ # Or null or "html" or "xhtml"
    extensions: ~ # Enable all with true or null (false to disable)

选择性地启用一个扩展

# GremoCiconiaBundle Configuration
gremo_ciconia:
    # ...
    extensions:
        fencedCodeBlock: ~ # Or true or null (false to disable) 
        # ...

使用方法

从服务容器中获取 ciconia 服务

/** @var \Ciconia\Ciconia $ciconia */
$ciconia = $container->get('ciconia');

// Refer to kzykhys/Ciconia for examples
$html = $ciconia->render('Markdown is **awesome**');

// <p>Markdown is <em>awesome</em></p>

或在 twig 模板中

{{ var|markdown }}

依赖注入标签

给服务分配一个名为 ciconia.extension 的标签,以自动将其注册为扩展。