markdown-extended / mde-editor
MarkdownExtended 网页编辑器(基于 EpicEditor)
Requires
- php: >=5.3.0
- markdown-extended/mde-service: dev-master
- piwi/markdown-extended: dev-master
Replaces
- piwi/mde-editor: *
This package is not auto-updated.
Last update: 2024-09-18 18:55:54 UTC
README
MDE(Markdown-Extended)语法网页编辑器。
此编辑器是原始EpicEditor的定制版本,用于使用PHP MarkdownExtended解析器。它使用MDE-Service PHP接口将编辑器的Markdown内容(通过同步XMLHttpRequest)在每次运行时提交(原始内容不在JavaScript中解析)。
此编辑器可在http://dingus.aboutmde.org/上在线使用。
安装
手动安装
wget --no-check-certificate https://github.com/markdown-extended/mde-editor/archive/master.tar.gz
tar -xvf master.tar.gz
cd mde-editor-master
bower install
composer install
然后您可以浏览演示页面:http://your.localhost/path/to/mde-editor-master/。
作为 Bower 依赖项的使用
MDE-Editor 已注册到Bower。但是,因为它仍然在PHP应用程序上,要获取“即用型”编辑器(安装了所需的PHP脚本),您必须使用该包的bower
分支,如下所示
bower install mde-editor#bower --save
或者您也可以在您的bower.json
配置文件中写入
"dependencies": {
"mde-editor": "bower"
}
使用
MDE-Editor 的使用方法与EpicEditor非常相似,除了
-
您必须在原始
epiceditor(.min).js
之后包含mde-editor.js
脚本<script src="mde-editor/mde-editor.js"></script>
-
您必须创建一个
MdeEpicEditor
对象而不是原始的EpicEditor
var editor = new MdeEpicEditor().load();
-
最终嵌入编辑器的DOM块的默认ID是
mde-editor
<div id="mde-editor"></div>
如果您移动了包文件,您需要保持 mde_editor_interface.php
PHP脚本与 mde-editor.js
在同一目录中(或覆盖 parser_options
设置 -参见下文)并重新定义 basePath
选项以适应您的环境。您还需要在 mde_editor_interface.php
脚本的开头重新定义 $autoloader
变量。
选项
MDE-Editor 的默认选项如下(它们将合并到最终对象中的默认EpicEditor选项)
container: 'mde-editor',
basePath: 'bower_components/epiceditor/epiceditor/',
autogrow: true,
file: {
name: 'mde-editor',
defaultContent: 'Type your *markdown*-**extended** content here ...',
autoSave: 5000
},
parserOptions: {
silent: false,
interface: 'mde-editor/mde_editor_interface.php',
mdeOptions: {}
}
最后一个 parserOptions
元素涉及MDE解析器
-
parserOptions.silent
是一个标志,用于查看错误或不是 -
parserOptions.interface
是从当前文档到PHP接口文件的路径;您还可以使用“在线”值来使用http://api.aboutmde.org/上的在线webservice(这对于通过 Bower 安装的包可能很有用,因为PHP依赖项可能没有安装) -
parserOptions.mdeOptions
条目是传递给PHP-MarkdownExtended解析器的选项表,以便您进行自定义解析;请注意,此条目中的元素必须遵循 下划线 表示法(无驼峰式)。
许可证
MDE-Editor 由 Pierre Cassat 开发,并使用 MIT 许可证授权。
要提交错误报告或功能请求,请参阅 http://github.com/markdown-extended/mde-editor/issues。