README

此模块为 Yii Framework 2.0 提供Markdown编辑和转换工具。它使用PHP Markdown Extra和PHP Smarty Pants进行Markdown转换。此外，您可以通过包含额外的自定义转换模式来自定义Markdown的口味。该模块还包括一个增强的Markdown编辑器小部件，用于运行时编辑和预览Markdown。此小部件使用Bootstrap 3.0进行样式设计。查看完整演示。

Markdown

查看演示
这是一个Markdown转换类，使用PHP Markdown Extra和PHP SmartyPantsTypographer处理Markdown转换为HTML。它还支持配置自定义转换处理模式，以在一定程度上自定义Markdown的口味。查看示例和详细说明或查看完整演示。

MarkdownEditor

查看演示
这是一个具有可配置选项的高级Markdown输入小部件。它使用Bootstrap 3.0进行样式设计。此小部件的主要功能包括：

1. 可配置的工具栏和按钮，用于格式化内容
2. Markdown格式文本的实时HTML预览
3. 最大化编辑器以进行全屏编辑
4. 实现了Markdown提供的PHP Markdown Extra和PHP SmartyPantsTypographer功能
5. 尽可能使用Bootstrap 3.0进行样式设计
6. 允许将文本编辑器内容保存/导出为文本或HTML
7. 可配置标题、页脚和输入选项
8. 支持本地化和自定义消息和内容

查看示例和详细说明或查看完整演示。

演示

您可以在此处看到这些功能的演示、文档和示例。

安装

安装此扩展的首选方法是使用composer。

注意：检查此扩展的composer.json以获取该扩展的需求和依赖项。阅读有关为应用程序的composer.json设置minimum-stability设置的网络提示/wik。

运行以下命令之一：

$ php composer.phar require kartik-v/yii2-markdown "dev-master"

或添加以下内容到您的composer.json文件的require部分：

"kartik-v/yii2-markdown": "dev-master"

用法

设置模块

将markdown添加到您的Yii配置文件的模块部分

'modules' = [
	/* other modules */
	'markdown' => [
		'class' => 'kartik\markdown\Module',
	]
];

您可以为markdown模块设置额外的配置选项

'modules' = [
	'markdown' => [
		// the module class
		'class' => 'kartik\markdown\Module',
		
		// the controller action route used for markdown editor preview
		'previewAction' => '/markdown/parse/preview',
		
		// the list of custom conversion patterns for post processing
		'customConversion' => [
			'<table>' => '<table class="table table-bordered table-striped">'
		],
		
		// whether to use PHP SmartyPantsTypographer to process Markdown output
		'smartyPants' => true
	]
	/* other modules */
];

Markdown

use kartik\markdown\Markdown;

// default call
echo Markdown::convert($content);

// with custom post processing
echo Markdown::convert($content, ['custom' => [
	'<h1>' => '<h1 class="custom-h1>',
	'<h2>' => '<h1 class="custom-h2>',
]]);

MarkdownEditor

// add this in your view
use kartik\markdown\MarkdownEditor;

// usage with model
echo MarkdownEditor::widget([
	'model' => $model, 
	'attribute' => 'markdown',
]);

// usage without model
echo MarkdownEditor::widget([
	'name' => 'markdown', 
	'value' => $value,
]);

许可协议

yii2-markdown采用BSD 3-Clause许可证发布。有关详细信息，请参阅附带LICENSE.md。