Wagtail Markdown 使用教程

Wagtail Markdown 使用教程

wagtail-markdown Markdown support for Wagtail 项目地址: https://gitcode.com/gh_mirrors/wa/wagtail-markdown

1. 项目介绍

Wagtail Markdown 是一个为 Wagtail CMS 提供 Markdown 支持的开源项目。它允许用户在 Wagtail 中使用 Markdown 语法进行内容输入，替代传统的富文本编辑器。Wagtail Markdown 提供了以下功能：

• MarkdownBlock: 用于 StreamFields 中的 Markdown 块。
• MarkdownField: 用于页面模型中的 Markdown 字段。
• Markdown 模板标签: 用于在模板中渲染 Markdown 内容。

Wagtail Markdown 基于 Python-Markdown，并添加了多个扩展以增强其在 Wagtail 中的实用性，包括代码高亮、内联链接、内联 Markdown 预览和表格支持。

2. 项目快速启动

安装

首先，使用 pip 安装 Wagtail Markdown：

pip install wagtail-markdown

或者使用 poetry：

poetry add wagtail-markdown

配置

安装完成后，在 Wagtail 项目的 settings.py 文件中添加 wagtailmarkdown 到 INSTALLED_APPS：

INSTALLED_APPS = [
    # 其他应用
    "wagtailmarkdown",
]

使用

在 Wagtail 页面模型中使用 MarkdownField：

from wagtail.models import Page
from wagtailmarkdown.fields import MarkdownField

class MyPage(Page):
    content = MarkdownField()

在 StreamFields 中使用 MarkdownBlock：

from wagtail.core.blocks import StreamBlock
from wagtailmarkdown.blocks import MarkdownBlock

class MyStreamBlock(StreamBlock):
    markdown = MarkdownBlock()

3. 应用案例和最佳实践

案例1：博客文章

在博客文章中使用 Markdown 可以简化内容编辑流程，特别是对于技术博客，Markdown 的代码块和语法高亮功能非常有用。

class BlogPage(Page):
    body = MarkdownField()

案例2：文档页面

对于技术文档或帮助文档，使用 Markdown 可以保持内容的简洁和一致性。

class DocumentationPage(Page):
    content = MarkdownField()

最佳实践

• 配置扩展: 根据需求配置 Markdown 扩展，如代码高亮、表格等。
• 自定义样式: 使用 Pygments 生成代码高亮样式，并应用到项目中。

4. 典型生态项目

Wagtail CMS

Wagtail 是一个基于 Django 的开源内容管理系统，专注于灵活性和易用性。Wagtail Markdown 是 Wagtail 生态系统中的一个重要扩展，增强了 Wagtail 在内容编辑方面的能力。

Python-Markdown

Wagtail Markdown 基于 Python-Markdown 库，这是一个功能强大的 Markdown 解析器，支持多种扩展和自定义功能。

EasyMDE

EasyMDE 是一个基于 SimpleMDE 的 Markdown 编辑器，提供了丰富的编辑功能和预览模式。Wagtail Markdown 使用 EasyMDE 进行内联 Markdown 预览。

通过这些生态项目的结合，Wagtail Markdown 为用户提供了强大的 Markdown 编辑和渲染能力，适用于各种内容管理需求。

wagtail-markdown Markdown support for Wagtail 项目地址: https://gitcode.com/gh_mirrors/wa/wagtail-markdown