Django入门与实践-第25章:Markdown 支持

让我们在文本区域添加 Markdown 支持来改善用户体验。你会看到要实现这个功能非常简单。

首先,我们安装一个名为 Python-Markdown 的库:

  1. pip install markdown

我们可以在 Post 视图的 model 中添加一个新的方法:

boards/models.py 查看完整文件

  1. from django.db import models
  2. from django.utils.html import mark_safe
  3. from markdown import markdown
  4. class Post(models.Model):
  5. # ...
  6. def get_message_as_markdown(self):
  7. return mark_safe(markdown(self.message, safe_mode='escape'))

这里我们正在处理用户的输入,所以我们需要小心一点。当使用 Mardown 功能时,我们需要先让它转义一下特殊字符,然后再解析出 Markdown 标签。这样做之后,输出字符串可以安全的在模板中使用。

现在,我们只需要在模板 topic_posts.htmlreply_topic.html 中修改一下 form。

  1. {{ post.message }}

修改为:

  1. {{ post.get_message_as_markdown }}

从现在起,用户就可以在帖子中使用 Mardown 语法来编辑了。

Django入门与实践-第25章:Markdown支持 - 图1

Django入门与实践-第25章:Markdown支持 - 图2

Markdown 编辑器

我们还可以添加一个名为 [SimpleMD](**)** 的非常酷的 Markdown 编辑器。

可以下载 JavaScript 库,后者使用他们的CDN:

  1. <link rel="stylesheet" href="https://cdn.jsdelivr.net/simplemde/latest/simplemde.min.css">
  2. <script src="https://cdn.jsdelivr.net/simplemde/latest/simplemde.min.js"></script>

现在来编辑一下 base.html ,为这些额外的Javascripts声明一个block (译者注:方便其他模板继承):

templates/base.html 查看完整文件

  1. <script src="{% static 'js/jquery-3.2.1.min.js' %}"></script>
  2. <script src="{% static 'js/popper.min.js' %}"></script>
  3. <script src="{% static 'js/bootstrap.min.js' %}"></script>
  4. {% block javascript %}{% endblock %} <!-- Add this empty block here! -->

首先来编辑 reply_topic.html 模板:

templates/reply_topic.html 查看完整文件

  1. {% extends 'base.html' %}
  2. {% load static %}
  3. {% block title %}Post a reply{% endblock %}
  4. {% block stylesheet %}
  5. <link rel="stylesheet" href="{% static 'css/simplemde.min.css' %}">
  6. {% endblock %}
  7. {% block javascript %}
  8. <script src="{% static 'js/simplemde.min.js' %}"></script>
  9. <script>
  10. var simplemde = new SimpleMDE();
  11. </script>
  12. {% endblock %}

默认情况下,这个插件会将它找到的第一个文本区域转换为 markdown 编辑器。所以这点代码应该就足够了:

Django入门与实践-第25章:Markdown支持 - 图3

接下来在 edit_post.html 模板中做同样的操作:

templates/edit_post.html 查看完整文件

  1. {% extends 'base.html' %}
  2. {% load static %}
  3. {% block title %}Edit post{% endblock %}
  4. {% block stylesheet %}
  5. <link rel="stylesheet" href="{% static 'css/simplemde.min.css' %}">
  6. {% endblock %}
  7. {% block javascript %}
  8. <script src="{% static 'js/simplemde.min.js' %}"></script>
  9. <script>
  10. var simplemde = new SimpleMDE();
  11. </script>
  12. {% endblock %}

Django入门与实践-第25章:Markdown支持 - 图4