Wagtail-Markdown 项目教程

Wagtail-Markdown 项目教程

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

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

Wagtail-Markdown 项目的目录结构如下：

wagtail-markdown/
├── src/
│   └── wagtailmarkdown/
│       ├── __init__.py
│       ├── blocks.py
│       ├── fields.py
│       ├── migrations/
│       ├── templates/
│       └── tests/
├── .editorconfig
├── .gitignore
├── .pre-commit-config.yaml
├── CHANGELOG.md
├── LICENSE
├── Makefile
├── README.md
├── pyproject.toml
├── ruff.toml
└── tox.ini

目录介绍

• src/wagtailmarkdown/: 包含项目的主要代码文件。
  • __init__.py: 模块初始化文件。
  • blocks.py: 定义 Markdown 块的文件。
  • fields.py: 定义 Markdown 字段的文件。
  • migrations/: 数据库迁移文件。
  • templates/: 模板文件。
  • tests/: 测试文件。
• .editorconfig: 编辑器配置文件。
• .gitignore: Git 忽略文件配置。
• .pre-commit-config.yaml: 预提交钩子配置。
• CHANGELOG.md: 变更日志。
• LICENSE: 许可证文件。
• Makefile: Makefile 文件。
• README.md: 项目说明文件。
• pyproject.toml: 项目配置文件。
• ruff.toml: Ruff 配置文件。
• tox.ini: Tox 配置文件。

2. 项目的启动文件介绍

Wagtail-Markdown 项目的启动文件主要是 src/wagtailmarkdown/__init__.py。这个文件初始化 Wagtail-Markdown 模块，并包含一些基本的配置和导入。

# src/wagtailmarkdown/__init__.py
 
# 初始化 Wagtail-Markdown 模块

3. 项目的配置文件介绍

Wagtail-Markdown 的配置文件主要包括 pyproject.toml 和 settings.py（假设在 Django 项目中）。

pyproject.toml

pyproject.toml 文件用于配置项目的构建系统和依赖管理。

# pyproject.toml
 
[tool.poetry]
name = "wagtail-markdown"
version = "0.10.0"
description = "Markdown support for Wagtail"
authors = ["Your Name <you@example.com>"]
 
[tool.poetry.dependencies]
python = "^3.8"
wagtail = "^4.1"
python-markdown = "^3.3"
 
[tool.poetry.dev-dependencies]
pytest = "^6.2"

settings.py

在 Django 项目的 settings.py 文件中，需要添加 Wagtail-Markdown 到已安装的应用列表中，并进行相关配置。

# settings.py
 
INSTALLED_APPS = [
    ...
    "wagtailmarkdown",
    ...
]
 
WAGTAILMARKDOWN = {
    "extensions": ["toc", "sane_lists"],
    "extension_configs": {
        "pymdownx.arithmatex": {"generic": True}
    }
}

以上是 Wagtail-Markdown 项目的基本教程，涵盖了项目的目录结构、启动文件和配置文件的介绍。希望对你有所帮助！

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