pjkui/yii2-markdown

Markdown editor for Yii2

v1.2.2 2026-04-22 15:16 UTC

Requires

• yiisoft/yii2: ~2.0.0

Requires (Dev)

• phpunit/phpunit: ^9.5 || ^10.0
• yidas/yii2-bower-asset: *

Apache-2.0

• Quinn Pan

• extension
• yii2

README

yii2-markdown 是一个基于 Cherry Markdown 封装的 Yii2 扩展，提供：

• Markdown 编辑器组件 pjkui\markdown\Editor
• Markdown 只读预览组件 pjkui\markdown\Preview
• 已打包的前端静态资源 EditorAsset
• 文件上传、草稿自动保存、快捷键提交、字数统计等增强能力

安装

composer require pjkui/yii2-markdown

快速开始

use pjkui\markdown\Editor;

echo Editor::widget([
    'model' => $model,
    'attribute' => 'content',
]);

文档

• 文档首页
• 安装说明
• 使用示例
• 配置说明
• 测试与可视化验证

目录结构

src/
  Editor.php
  Preview.php
  EditorAsset.php
  dist/
docs/
  README.md
  installation.md
  usage.md
  configuration.md

说明

• 当前包通过 composer.json 将命名空间 pjkui\markdown\ 映射到 src/
• Editor 默认输出隐藏的 textarea 加前端编辑器容器，便于表单提交
• Preview 适合详情页、只读预览区域等场景

更多细节请查看 docs。