django-mdeditor: Django-mdeditor 是基于 Editor.md 的一个 django Markdown 文本编辑插件应用。

# django-mdeditor

[![ENV](https://img.shields.io/badge/release-v0.1.20-blue.svg)](https://github.com/pylixm/django-mdeditor)
[![ENV](https://img.shields.io/badge/中文文档-v0.1.20-blue.svg)](./README_CN.md)
[![ENV](https://img.shields.io/badge/gitter-v0.1.20-blue.svg)](https://gitter.im/django-mdeditor/Lobby)
[![ENV](https://img.shields.io/badge/python-2.x/3.x-green.svg)](https://github.com/pylixm/django-mdeditor)
[![ENV](https://img.shields.io/badge/django-1.7+-green.svg)](https://github.com/pylixm/django-mdeditor)
[![LICENSE](https://img.shields.io/badge/license-GPL3.0-green.svg)](https://github.com/pylixm/django-mdeditor/master/LICENSE.txt)

**Django-mdeditor** 是基于 [Editor.md](https://github.com/pandao/editor.md) 的一个 [django](djangoproject.com) Markdown 文本编辑插件应用。

**Django-mdeditor** 的灵感参考自伟大的项目 [django-ckeditor](https://github.com/django-ckeditor/django-ckeditor).

**注：**

- 关于Markdown页面渲染问题，建议后端渲染。因`Editor.md` 已长时间不更新有些bug和兼容性问题需要自己调试，当然前端同学可自行选择。
- 关于`Jquery`冲突问题，因admin后端需要，无法删除。建议将编辑页面单独一页或直接单独全屏一页，使用自己单独的静态文件，与其他页面区分。

## 功能

- 支持 Editor.md 大部分功能 
    - 支持标准的Markdown 文本、 CommonMark 和 GFM (GitHub Flavored Markdown) 文本;
    - 支持实时预览、图片上传、格式化代码、搜索替换、皮肤、多语言等。
    - 支持TOC 目录和表情；
    - 支持 TeX, 流程图、时序图等图表扩展。
- 可自定义 Editor.md 工具栏。 
- 提供了 `MDTextField` 字段用来支持模型字段使用。
- 提供了 `MDTextFormField` 字段用来支持 `Form` 和 `ModelForm`.
- 提供了 `MDEditorWidget` 字段用来支持 `admin` 自定义样式使用。

## 快速入门

- 安装
```bash
    pip install django-mdeditor
```

- 在 `settings` 配置文件 `INSTALLED_APPS` 中添加 `mdeditor`:
```python
    INSTALLED_APPS = [
        ...
        'mdeditor',
    ]
```

- 针对django3.0+修改 frame 配置，如下：

```python
X_FRAME_OPTIONS = 'SAMEORIGIN'  # django 3.0 + 默认为 deny
```

- 在 `settings` 中添加媒体文件的路径配置:
```python
MEDIA_ROOT = os.path.join(BASE_DIR, 'uploads')
MEDIA_URL = '/media/'

```
在你项目根目录下创建 `uploads/editor` 目录，用于存放上传的图片。

- 在你项目的根 `urls.py` 中添加扩展url和媒体文件url:
```python
from django.conf.urls import url, include
from django.conf.urls.static import static
from django.conf import settings
...

urlpatterns = [
    ...
    url(r'mdeditor/', include('mdeditor.urls'))
]

if settings.DEBUG:
    # static files (images, css, javascript, etc.)
    urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)

```

- 编写一个测试 model :
```python
from django.db import models
from mdeditor.fields import MDTextField

class ExampleModel(models.Model):
    name = models.CharField(max_length=10)
    content = MDTextField()
```

- 向 `admin.py` 中注册model:
```python
from django.contrib import admin
from . import models

admin.site.register(models.ExampleModel)

```

- 运行 `python manage.py makemigrations` 和 `python manage.py migrate` 来创建你的model 数据库表.

- 登录 django admin后台，点击 '添加'操作，你会看到如下界面。

![](/screenshot/admin-example.png)

到此，你已经初步体验了 `djang-mdeditor` ，接下来详细看下他的其他使用吧。

## 用法说明

### 在model 中使用 Markdown 编辑字段

在model 中使用 Markdown 编辑字段，我们只需要将 model 的`TextField` 替换成`MDTextField` 即可。

```python
from django.db import models
from mdeditor.fields import MDTextField

class ExampleModel(models.Model):
    name = models.CharField(max_length=10)
    content = MDTextField()
```

在后台admin中，会自动显示 markdown 的编辑富文本。

在前端 template 中使用时，可以这样用：
```python
{% load staticfiles %}
<!DOCTYPE html>
<html lang="zh">
    <head>
        <meta http-equiv="Content-Type" content="text/html; charset=utf-8" />

</head>
    <body>
        <form method="post" action="./">
            {% csrf_token %}
            {{ form.media }}
            {{ form.as_p }}
            <p><input type="submit" value="post"></p>
        </form>
    </body>
</html>

```

### 在 Form 中使用 markdown 编辑字段

在 Form 中使用 markdown 编辑字段，使用 `MDTextFormField` 代替 `forms.CharField`, 如下：
```python
from mdeditor.fields import MDTextFormField

class MDEditorForm(forms.Form):
    name = forms.CharField()
    content = MDTextFormField()
```

`ModelForm` 可自动将model 对应的字段转为 form字段， 可正常使用：
```python
class MDEditorModleForm(forms.ModelForm):

class Meta:
        model = ExampleModel
        fields = '__all__'
```

### 在 admin 中使用 markdown 小组件

在 admin 中使用 markdown 小组件，如下：
```python
from django.contrib import admin
from django.db import models

# Register your models here.
from . import models as demo_models
from mdeditor.widgets import MDEditorWidget

class ExampleModelAdmin(admin.ModelAdmin):
    formfield_overrides = {
        models.TextField: {'widget': MDEditorWidget}
    }

admin.site.register(demo_models.ExampleModel, ExampleModelAdmin)
```

### 自定义工具栏

在 `settings` 中增加如下配置 ：
```python
MDEDITOR_CONFIGS = {
'default':{
    'width': '90%',  # 自定义编辑框宽度
    'heigth': 500,   # 自定义编辑框高度
    'toolbar': ["undo", "redo", "|",
                "bold", "del", "italic", "quote", "ucwords", "uppercase", "lowercase", "|",
                "h1", "h2", "h3", "h5", "h6", "|",
                "list-ul", "list-ol", "hr", "|",
                "link", "reference-link", "image", "code", "preformatted-text", "code-block", "table", "datetime",
                "emoji", "html-entities", "pagebreak", "goto-line", "|",
                "help", "info",
                "||", "preview", "watch", "fullscreen"],  # 自定义编辑框工具栏
    'upload_image_formats': ["jpg", "jpeg", "gif", "png", "bmp", "webp"],  # 图片上传格式类型
    'image_folder': 'editor',  # 图片保存文件夹名称
    'theme': 'default',  # 编辑框主题 ，dark / default
    'preview_theme': 'default',  # 预览区域主题， dark / default
    'editor_theme': 'default',  # edit区域主题，pastel-on-dark / default
    'toolbar_autofixed': True,  # 工具栏是否吸顶
    'search_replace': True,  # 是否开启查找替换
    'emoji': True,  # 是否开启表情功能
    'tex': True,  # 是否开启 tex 图表功能
    'flow_chart': True,  # 是否开启流程图功能
    'sequence': True,  # 是否开启序列图功能
    'watch': True,  # 实时预览
    'lineWrapping': False,  # 自动换行
    'lineNumbers': False  # 行号
    }
}
```

## 反馈交流

欢迎反馈和交流！

你可以创建 [issue](https://github.com/pylixm/django-mdeditor/issues) 或加入QQ 群。

![](screenshot/QQ.png)

## 参考

-[django-ckeditor](https://github.com/django-ckeditor/django-ckeditor)

pyli.xm/django-mdeditor

简介

发行版

贡献者

语言

近期动态

pyli.xm/django-mdeditor .gitee-modal { width: 500px !important; }

简介

发行版

开源评估指数源自 OSS-Compass 评估体系，评估体系围绕以下三个维度对项目展开评估：

贡献者

语言

近期动态

搜索帮助

pyli.xm/django-mdeditor