rkeet / zf-form-markdown
此包已被弃用且不再维护。未建议替代包。
提供表单元素 'Markdown',用于在 Zend Framework 3 中与 Zend Form 一起使用。
0.1.4
2020-03-22 10:01 UTC
Requires
- php: ^7.2 || ^7.3
- erusev/parsedown: ^1.7
- rwoverdijk/assetmanager: ^1.8
- zendframework/zend-form: ^2.14
- zendframework/zend-servicemanager: ^2.7.8 || ^3.4
README
提供使用 markdown
作为输入元素类型的能力。
设置
要求模块
要安装最新版本,使用 Composer 运行
composer require rkeet/zf-form-markdown
启用模块
要启用此模块,需要同时启用此模块和 AssetManager。在 modules.config.php
中添加以下内容
'AssetManager',
'Keet\Markdown',
在表单/字段集中使用
元素提供 HTML <textarea>
元素和配对的 <div>
元素,用于渲染文本区域中输入内容的预览。
use Keet\Markdown\Form\Element\Markdown;
...
$this->add(
[
'name' => 'body',
'type' => Markdown::class,
'options' => [
'label' => 'Body',
],
'attributes' => [
'rows' => 4,
],
]
);
模块要求
- Zend Form 扩展
- Parsedown 用于 PHP 侧将 Markdown 转换为 HTML
- ShowdownJS 用于客户端将 Markdown 转换为 HTML 预览
- AssetManager 用于通过 ViewHelper 注入 JS
功能
- 提供处理 Markdown 转换的服务(
MarkdownService
) - 提供用于表单输入的 ZF 表单元素(
Markdown
)- 在使用
Markdown
表单元素时提供给客户端 Showdown
- 在使用
待办事项
- 创建更好的预览 - 可能
- 选项:注入可覆盖的默认样式
- 选项:侧边预览而不是上方/下方
- 选项:始终可见的预览容器(可覆盖)的最小样式
- 找出 Parsedown 和 ShowdownJS 之间的不兼容性