Repolode
提交项目
timvink

timvink/mkdocs-print-site-plugin

为 MkDocs 站点添加一个合并所有页面的打印页，便于导出 PDF 或独立 HTML。

在 GitHub 查看官网
Star
189
Fork
30
未关闭 Issue
13
最近提交
3天前

这是什么？

mkdocs-print-site-plugin 是 MkDocs（基于 Python 的文档静态站点生成器）的插件。它会额外生成一个打印页面，把站点所有页面按顺序合并成一份文档，方便整体导出为单个 PDF 或独立 HTML 文件。

打印页位于 /print_page/ 或 print_page.html。PDF 通过浏览器打印该页面生成，插件支持 PDF 分页，并提供封面页和多种外观定制选项。它兼容 mkdocs-material、mkdocs-materialx 和 readthedocs 主题，也支持 autorefs 插件，唯一依赖是 mkdocs。

建议将插件放在 mkdocs.yml 插件列表的末尾，以便其他插件对导航等的修改也能包含在合并结果中。

核心功能

  • 01添加打印页，将站点所有页面合并为一份文档
  • 02可通过浏览器打印导出 PDF，或导出独立 HTML
  • 03支持 PDF 分页和可选封面页
  • 04兼容 mkdocs-material、mkdocs-materialx 和 readthedocs 主题
  • 05支持 autorefs 插件
  • 06唯一依赖为 mkdocs

适用场景

  • 为项目文档站点提供完整的离线 PDF 版本
  • 分发单个独立 HTML 格式的文档
  • 从基于 MkDocs 的文档站点生成可打印手册

快速上手

  1. 1

    使用 pip 安装插件

    pip3 install mkdocs-print-site-plugin
  2. 2

    在 mkdocs.yml 的 plugins 列表底部添加 print-site

  3. 3

    在站点中打开 /print_page/ 或 print_page.html 查看合并后的打印页面

使用前须知

  • PDF 导出依赖浏览器的打印功能。

收录于专题

PDF、OCR 与文档处理工具静态网站生成器与文档工具

标签

#mkdocs#mkdocs-plugin#pdf#documentation#static-site#python#pdfs#print

常见问题

mkdocs-print-site-plugin 是什么？
为 MkDocs 站点添加一个合并所有页面的打印页，便于导出 PDF 或独立 HTML。 mkdocs-print-site-plugin 是 MkDocs（基于 Python 的文档静态站点生成器）的插件。它会额外生成一个打印页面，把站点所有页面按顺序合并成一份文档，方便整体导出为单个 PDF 或独立 HTML 文件。
mkdocs-print-site-plugin 可以免费使用吗？用的什么许可证？
mkdocs-print-site-plugin 以 MIT 许可证开源。用于商业产品前，请先确认许可证条款。
mkdocs-print-site-plugin 还在维护吗？
活跃维护中。mkdocs-print-site-plugin 最近一次提交是在 2026年11月4日。
mkdocs-print-site-plugin 适合用来做什么？
为项目文档站点提供完整的离线 PDF 版本 分发单个独立 HTML 格式的文档 从基于 MkDocs 的文档站点生成可打印手册
mkdocs-print-site-plugin 怎么安装和运行？
使用 pip 安装插件: pip3 install mkdocs-print-site-plugin 在 mkdocs.yml 的 plugins 列表底部添加 print-site 在站点中打开 /print_page/ 或 print_page.html 查看合并后的打印页面
在哪里获取 mkdocs-print-site-plugin？
源代码和安装说明在 GitHub 上：https://github.com/timvink/mkdocs-print-site-plugin

概要由 AI 根据项目 README 生成；GitHub 数据每日更新。

相关项目