markdown

项目概述

Python-Markdown 是 John Gruber 的 Markdown 在 Python 平台的实现，与参考实现高度兼容。它把 Markdown 文本转换为 HTML，内置常用语法元素，并提供丰富的扩展机制，表格、脚注、目录、代码高亮等增强语法都能通过扩展开启。

一行函数调用，把 Markdown 文本变成标准 HTML。

主要功能

• 核心转换：markdown.markdown 一步把文本转为 HTML
• 扩展机制：表格、脚注、目录、属性列表等官方扩展按需启用
• 第三方生态：支持社区扩展，覆盖代码高亮、任务列表等需求
• 命令行工具：安装后可用 markdown_py 命令直接转换文件
• API 灵活：支持自定义输出格式与注册自定义扩展
• 兼容性好：与 Markdown 参考实现行为高度一致

适用人群

• 需要渲染 Markdown 的 Web 开发者
• 文档站点与博客系统开发者
• 构建笔记或内容管理工具的团队
• 需要自定义 Markdown 语法的工程师

快速上手

1. 安装

pip install markdown

2. 转换文本

import markdown

html = markdown.markdown('# Hello')

3. 启用扩展，例如表格与脚注

html = markdown.markdown(text, extensions=['tables', 'footnotes'])

核心优势

• 标准兼容：与 Markdown 参考实现行为一致，输出可靠
• 按需扩展：核心保持精简，语法增强通过扩展叠加
• 生态成熟：长期维护、广泛使用，文档与扩展齐全

系统要求

注意事项

• 不做内容净化：库本身不过滤 HTML，展示用户提交内容需配合净化库防 XSS
• 扩展需显式开启：表格、脚注等不在默认语法内，要按需加载