讲师中心 微信公众号
AI工具推荐 视频效率加速

新手如何用Python构建Markdown转HTML的文档生成器

酷枫小哥_1950

酷枫小哥_1950

发布时间:2026-11-01 06:35:20

|

286人浏览过

|

来源于php中文网

原创

markdown.markdown()仅输出无结构的HTML片段,缺乏完整文档框架、样式、目录、锚点ID及资源路径处理,需启用extra/codehilite/toc扩展并手动补全HTML模板才能生成可用文档。

新手如何用python构建markdown转html的文档生成器

直接用 markdown 库就能跑通基础流程,不需要自己解析语法或写渲染器。但想生成可用的文档(带样式、目录、链接跳转),光靠 markdown.markdown() 远远不够——它只输出裸 HTML 片段,没 结构、没 CSS、不处理图片路径、也不生成目录。

为什么不能只调用 markdown.markdown()

这个函数只是把 Markdown 字符串转成一段 HTML 内容(比如 <p>Hello</p> <ul><li>item</li></ul>),不包含 、、DOCTYPE,也没办法自动加 Bootstrap 样式或锚点 ID。常见错误是直接保存结果到 .html 文件,打开后文字堆在一起、无缩进、标题不可点击、图片 404。

  • 输出不含完整 HTML 文档结构 → 浏览器渲染异常或样式丢失
  • 标题没有 id 属性 → 无法用 [TOC] 或 JS 生成目录
  • 相对路径的图片/链接仍保持原样 → 本地预览时资源加载失败
  • 不支持表格、脚注、代码行号等扩展 → 遇到 ~~~python 块可能被忽略

必须启用的三个扩展:extra、codehilite、toc

它们不是可选插件,而是解决实际问题的刚需配置。缺一不可:

  • extra:支持表格、围栏代码块(```)、定义列表、脚注等常用语法
  • codehilite:给 ```python 这类代码块加上 Pygments 高亮(需提前 pip install pygments)
  • toc:为每个标题自动添加 id,并支持在文档里用 [TOC] 占位符生成目录

实操写法:

立即学习“Python免费学习笔记(深入)”;

财经HTML高端海报生成
财经HTML高端海报生成

复杂得财经如何变成清晰,适合手机看的海报?如何加上你的IP

下载
import markdown
md = markdown.Markdown(
    extensions=['extra', 'codehilite', 'toc'],
    extension_configs={
        'codehilite': {'guess_lang': False, 'css_class': 'highlight'},
        'toc': {'permalink': True}
    }
)
html_body = md.convert(md_text)
toc_html = md.toc  # 注意:必须在 convert() 之后取

如何拼出一个能直接打开的完整 HTML 文件

需要手动补全 HTML 模板,并注入内容。关键点在于:路径要相对当前生成位置处理,CSS 要内联或指定 CDN,否则离线打不开。

  • 不要硬编码绝对路径;用 os.path.relpath() 或直接内联样式避免依赖外部文件
  • 如果用 CDN 引入 Bootstrap,确保网络通畅;离线场景建议用 pygments 生成的 CSS 内联(PygmentsCssFormatter().get_style_defs())
  • 图片路径默认不会重写 → 若源 Markdown 中是 ![](img/logo.png),且目标 HTML 和图片不在同级目录,需手动替换 src 值
  • 生成的 md.toc 是带 <div class="toc"> 的 HTML 字符串,需插入到模板中合适位置(通常在正文前)<p>最小可用模板示例:</p><pre class='brush:python;toolbar:false;'>template = &quot;&quot;&quot;&lt;!DOCTYPE html&gt;&lt;html&gt;&lt;head&gt;&lt;meta charset=&quot;utf-8&quot;&gt;&lt;title&gt;{title}&lt;/title&gt;&lt;style&gt;{pygments_css}&lt;/style&gt;&lt;/head&gt;&lt;body&gt;{toc}&lt;article&gt;{content}&lt;/article&gt;&lt;/body&gt;&lt;/html&gt; &quot;&quot;&quot; html_full = template.format( title=&quot;My Doc&quot;, pygments_css=formatter.get_style_defs(), toc=toc_html, content=html_body ) </pre><h3>容易被忽略的路径与编码细节</h3> <p>90% 的“生成后图片不显示”“中文乱码”问题都出在这儿:</p> <ul> <li>读取 Markdown 文件时没指定 <code>encoding='utf-8' → 中文标题变 你好
  • 用 open(..., 'w') 写 HTML 时没加 encoding='utf-8' → 浏览器识别成 GBK,中文全乱码
  • Markdown 里写 ![](./assets/chart.png),但生成 HTML 放在 docs/index.html,路径就变成 docs/./assets/chart.png → 必须统一按输出目录为基准重写所有 src 和 href
  • Windows 下路径分隔符是 ,但 HTML 只认 / → 用 path.replace('\', '/') 统一处理

这些不是“高级技巧”,是每次生成前必须检查的落地细节。漏掉任意一项,文档看起来就是半成品。

相关文章

HTML速学教程(入门课程)
HTML速学教程(入门课程)

HTML怎么学习?HTML怎么入门?HTML在哪学?HTML怎么学才快?不用担心,这里为大家提供了HTML速学教程(入门课程),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

热门AI工具

更多
DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

UpDream
UpDream Hot

一款AI视频创作工具,主要用于哔哩哔哩推出的自研AI视频创作工具,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

讯飞绘文

讯飞绘文是一款由科大讯飞推出的一站式 AIGC 内容运营平台。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

VibeKnow
VibeKnow Hot

一款AI视频创作工具,主要用于全球首个AI知识视频创作平台,文档、文章、网页,一键生成视频,适合需要提升相关任务效率的用户。

超级简历WonderCV

一款AI办公效率工具,主要用于免费求职简历模版下载制作,应届生职场人必备简历制作神器,适合需要提升相关任务效率的用户。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

相关专题

更多
python打包成可执行文件
python打包成可执行文件

本专题为大家带来python打包成可执行文件相关的文章,大家可以免费的下载体验。

1831

2023.07.20

python能做什么
python能做什么

python能做的有:可用于开发基于控制台的应用程序、多媒体部分开发、用于开发基于Web的应用程序、使用python处理数据、系统编程等等。本专题为大家提供python相关的各种文章、以及下载和课程。

4964

2023.07.25

format在python中的用法
format在python中的用法

Python中的format是一种字符串格式化方法,用于将变量或值插入到字符串中的占位符位置。通过format方法,我们可以动态地构建字符串,使其包含不同值。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

1789

2023.07.31

python教程
python教程

Python已成为一门网红语言,即使是在非编程开发者当中,也掀起了一股学习的热潮。本专题为大家带来python教程的相关文章,大家可以免费体验学习。

29757

2023.08.03

python环境变量的配置
python环境变量的配置

Python是一种流行的编程语言,被广泛用于软件开发、数据分析和科学计算等领域。在安装Python之后,我们需要配置环境变量,以便在任何位置都能够访问Python的可执行文件。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3547

2023.08.04

python eval
python eval

eval函数是Python中一个非常强大的函数,它可以将字符串作为Python代码进行执行,实现动态编程的效果。然而,由于其潜在的安全风险和性能问题,需要谨慎使用。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

3567

2023.08.04

scratch和python区别
scratch和python区别

scratch和python的区别:1、scratch是一种专为初学者设计的图形化编程语言,python是一种文本编程语言;2、scratch使用的是基于积木的编程语法,python采用更加传统的文本编程语法等等。本专题为大家提供scratch和python相关的文章、下载、课程内容,供大家免费下载体验。

1223

2023.08.11

python合并两个列表
python合并两个列表

Python是一种强大的编程语言,具有许多方便的功能和工具。在Python中,有多种方法可以合并两个列表。php中文网给大家带来了相关的教程以及文章,欢迎大家前来学习阅读。

616

2023.08.10

Vite 项目如何打包和部署
Vite 项目如何打包和部署

Vite项目打包部署专题汇集生产构建、产物预览、输出目录、资源路径、Nginx与GitHub Pages部署及常见白屏和路由404问题的已审核文章,帮助读者完成上线流程。

60

2026.10.28

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Uvicorn官方安装与入门手册
Uvicorn官方安装与入门手册

共0课时 | 0人学习

Python uv官方项目管理指南
Python uv官方项目管理指南

共0课时 | 0人学习

Python uv官方安装与入门文档
Python uv官方安装与入门文档

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn