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

1. 项目的目录结构及介绍

wagtailcodeblock/
├── docs/
│   └── img/
├── tests/
├── wagtailcodeblock/
│   ├── migrations/
│   ├── static/
│   ├── templates/
│   ├── __init__.py
│   ├── blocks.py
│   ├── models.py
│   ├── apps.py
│   └── views.py
├── .gitignore
├── LICENSE
├── README.md
├── conftest.py
├── manage.py
├── pyproject.toml
└── requirements.txt

• docs/: 包含项目文档的图片等资源。
• tests/: 包含项目的测试文件。
• wagtailcodeblock/: 项目的主要代码目录。
  • migrations/: 数据库迁移文件。
  • static/: 静态文件，如CSS和JavaScript。
  • templates/: 模板文件。
  • __init__.py: 初始化文件。
  • blocks.py: 定义代码块的文件。
  • models.py: 定义模型的文件。
  • apps.py: 应用配置文件。
  • views.py: 视图文件。
• .gitignore: Git忽略文件。
• LICENSE: 项目许可证。
• README.md: 项目说明文档。
• conftest.py: 测试配置文件。
• manage.py: Django管理文件。
• pyproject.toml: 项目配置文件。
• requirements.txt: 项目依赖文件。

2. 项目的启动文件介绍

• manage.py: 这是Django项目的管理文件，用于启动开发服务器、运行迁移、创建超级用户等。

python manage.py runserver

3. 项目的配置文件介绍

• pyproject.toml: 这是项目的配置文件，包含了项目的依赖、构建工具等信息。

[tool.poetry]
name = "wagtailcodeblock"
version = "0.3.1"
description = "Wagtail Code Block provides PrismJS syntax highlighting in Wagtail"
authors = ["Tim Allen <tallen@wharton.upenn.edu>"]
license = "BSD-3-Clause"

[tool.poetry.dependencies]
python = "^3.6"
wagtail = "^2.0"

[tool.poetry.dev-dependencies]
pytest = "^6.0"

• settings.py: 这是Django项目的配置文件，包含了数据库配置、应用安装、中间件、静态文件配置等。

INSTALLED_APPS = [
    'wagtailcodeblock',
    # 其他应用
]

WAGTAIL_CODE_BLOCK_LINE_NUMBERS = True
WAGTAIL_CODE_BLOCK_COPY_TO_CLIPBOARD = True
WAGTAIL_CODE_BLOCK_THEME = 'coy'

通过以上配置，可以启用行号、复制到剪贴板功能，并选择PrismJS的主题。

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