README

此软件包创建一个 markdown 表单字段，允许实时预览 markdown 标记。它打算用于使用 Twitter Bootstrap 构建的用户界面。此软件包与 SonataAdminBundle 或 MopaBootstrapBundle 配套使用。

您应使用 KnpMarkdownBundle 在前端渲染 markdown。

Markdown 字段通过使用以下工具渲染控件和预览：

安装

通过将其添加到您的 composer.json，在您的 Symfony2 项目中安装此软件包。

{
    "require": {
        "ornj/markdown-bundle": "dev-master"
    }
}

运行更新 composer 后，在 app/AppKernel.php 中注册软件包。

$bundles = array(
   // ...
   new Ornj\Bundle\MarkdownBundle\OrnjMarkdownBundle(),
);

使用

启用 Twig 模板

此软件包提供用于渲染 markdown 字段的 Twig 模板。要使用它，有两种选择。

通过将模板添加到 config.yml 全局启用

twig:
    form:
        resources:
            - 'OrnjMarkdownBundle:Form:fields.html.twig'

或

在表单的 twig 模板中添加模板

{% form_theme form 'OrnjMarkdownBundle:Form:fields.html.twig' %}

添加样式和 JavaScript

扩展或修改您的基 admin 模板，并添加以下样式。可以使用 SCSS 或 CSS。

SCSS

{% stylesheets filter="cssrewrite, compass"
    '@OrnjMarkdownBundle/Resources/public/scss/*'
%}
<link rel="stylesheet" href="{{ asset_url }}" type="text/css" media="all" />
{% endstylesheets %}

CSS

{% stylesheets filter="cssrewrite, compass"
    '@OrnjMarkdownBundle/Resources/public/css/*'
%}
<link rel="stylesheet" href="{{ asset_url }}" type="text/css" media="all" />
{% endstylesheets %}

JavaScript

扩展或修改您的基 admin 模板，并添加以下 JavaScript。

{% javascripts
    '@OrnjMarkdownBundle/Resources/public/js/markdown.js'
    '@OrnjMarkdownBundle/Resources/public/js/to-markdown.js'
    '@OrnjMarkdownBundle/Resources/public/js/bootbox.js'
    '@OrnjMarkdownBundle/Resources/public/js/bootstrap-markdown.js'
%}
<script type="text/javascript" src="{{ asset_url }}"></script>
{% endjavascripts %}

表单字段

markdown 字段是 textarea 的扩展。它可以用于渲染任何期望字符串的字段。

$builder->add('body', 'markdown');

前端渲染

您需要一个解析器才能将 markdown 渲染为 HTML。 KnpMarkdownBundle 添加了一个方便的 Twig 扩展，用于渲染结果。

待办事项

允许包含 textarea 选项。
研究从软件包中移除物理依赖副本。
允许通过配置自定义 ui 选项。

ornj / markdown-bundle

维护者

详细信息