Wagtail Code Block 使用教程

Wagtail Code Block 使用教程

wagtailcodeblockStreamField code blocks for the Wagtail CMS with real-time PrismJS Syntax Highlighting.项目地址:https://gitcode.com/gh_mirrors/wa/wagtailcodeblock

项目介绍

Wagtail Code Block 是一个为 Wagtail CMS 提供的代码高亮块插件，它使用 PrismJS 库在 Wagtail 编辑器和前端实现实时语法高亮、行号显示以及支持多种 PrismJS 主题。

项目快速启动

安装

首先，确保你已经安装了 Wagtail CMS。然后，根据你的 Wagtail 版本安装 Wagtail Code Block：

# Wagtail 4.0 及以上版本
pip install wagtailcodeblock

# Wagtail 3.x 版本
pip install wagtailcodeblock==1.28.0.0

# Wagtail 2.x 版本
pip install wagtailcodeblock==1.25.0.2

配置

在 Django 的 settings.py 文件中添加 wagtailcodeblock 到 INSTALLED_APPS：

INSTALLED_APPS = [
    ...
    'wagtailcodeblock',
    ...
]

使用

在你的 Wagtail 页面模型中使用 CodeBlock：

from wagtail.core.models import Page
from wagtail.core.fields import StreamField
from wagtail.admin.edit_handlers import FieldPanel
from wagtailcodeblock.blocks import CodeBlock

class HomePage(Page):
    body = StreamField([
        ('heading', TextBlock()),
        ('code', CodeBlock(label='Code')),
    ])

    content_panels = Page.content_panels + [
        FieldPanel('body'),
    ]

应用案例和最佳实践

案例一：技术博客

在技术博客中使用 Wagtail Code Block 可以方便地展示代码示例，提高文章的可读性和专业性。例如，展示 Python 代码：

def hello_world():
    print("Hello, world!")

案例二：开发者文档

在开发者文档中使用 Wagtail Code Block 可以清晰地展示 API 使用示例，帮助开发者快速理解和使用 API。例如，展示 REST API 调用代码：

curl -X GET "https://api.example.com/data" -H "Authorization: Bearer YOUR_TOKEN"

典型生态项目

Wagtail CMS

Wagtail Code Block 是 Wagtail CMS 的一个插件，Wagtail CMS 是一个强大的内容管理系统，适用于各种类型的网站和应用。

PrismJS

Wagtail Code Block 使用 PrismJS 进行语法高亮，PrismJS 是一个轻量级、可扩展的语法高亮库，支持多种编程语言和主题。

通过以上步骤，你可以快速启动并使用 Wagtail Code Block 插件，提升你的 Wagtail CMS 项目的代码展示效果。

wagtailcodeblockStreamField code blocks for the Wagtail CMS with real-time PrismJS Syntax Highlighting.项目地址:https://gitcode.com/gh_mirrors/wa/wagtailcodeblock