Django Markdownify 项目教程

Django Markdownify 项目教程

django-markdownifyMarkdown template filter for Django项目地址:https://gitcode.com/gh_mirrors/dj/django-markdownify

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

Django Markdownify 项目的目录结构如下：

django-markdownify/
├── django_markdownify/
│   ├── __init__.py
│   ├── filters.py
│   ├── settings.py
│   ├── urls.py
│   └── views.py
├── manage.py
├── README.md
├── requirements.txt
└── setup.py

目录结构介绍

• django_markdownify/: 这是 Django Markdownify 的核心目录，包含了项目的所有 Python 文件。

  • __init__.py: 使该目录成为一个 Python 包。
  • filters.py: 包含 Markdown 转换为 HTML 的过滤器逻辑。
  • settings.py: 项目的配置文件，包含 Markdownify 的设置。
  • urls.py: 项目的 URL 配置文件。
  • views.py: 包含项目的视图逻辑。

• manage.py: Django 项目的管理脚本，用于启动项目、运行测试等。

• README.md: 项目的说明文档，包含项目的介绍、安装和使用说明。

• requirements.txt: 项目依赖的 Python 包列表。

• setup.py: 用于打包和分发项目的脚本。

2. 项目的启动文件介绍

项目的启动文件是 manage.py。这个文件是 Django 项目的标准管理脚本，用于启动项目、运行测试、创建数据库迁移等。

启动项目

要启动 Django 项目，可以使用以下命令：

python manage.py runserver

这将启动 Django 开发服务器，默认情况下在 http://127.0.0.1:8000/ 上运行。

3. 项目的配置文件介绍

项目的配置文件是 django_markdownify/settings.py。这个文件包含了 Django Markdownify 的所有配置选项。

配置文件内容

# django_markdownify/settings.py

# Markdownify 配置
MARKDOWNIFY_STRIP = True
MARKDOWNIFY_WHITELIST_TAGS = [
    'a', 'abbr', 'acronym', 'b', 'blockquote', 'em', 'i', 'li', 'ol', 'p', 'strong', 'ul'
]
MARKDOWNIFY_WHITELIST_ATTRS = [
    'href', 'src', 'alt'
]

配置项介绍

• MARKDOWNIFY_STRIP: 是否在转换 Markdown 时去除 HTML 标签。
• MARKDOWNIFY_WHITELIST_TAGS: 允许的 HTML 标签列表。
• MARKDOWNIFY_WHITELIST_ATTRS: 允许的 HTML 属性列表。

这些配置项可以根据项目需求进行调整，以确保 Markdown 转换为 HTML 时的安全性和灵活性。

django-markdownifyMarkdown template filter for Django项目地址:https://gitcode.com/gh_mirrors/dj/django-markdownify