Repolode
timvink

timvink/mkdocs-print-site-plugin

Плагин для MkDocs, который создаёт страницу со всей документацией сайта, чтобы её можно было экспортировать в PDF или отдельный HTML-файл.

Звёзды
189
Форки
30
Открытые issues
13
Последний коммит
3 дня назад

Что это?

mkdocs-print-site-plugin — плагин для MkDocs, генератора статических сайтов документации на Python. Он создаёт дополнительную страницу, объединяющую все страницы сайта в один документ, чтобы всю документацию можно было сохранить в виде PDF или отдельного HTML-файла.

Страница для печати доступна по адресу /print_page/ или print_page.html. PDF-файл можно получить, распечатав эту страницу из браузера. Плагин поддерживает разбиение PDF на страницы, а также настройку обложки и оформления. Он совместим с темами mkdocs-material, mkdocs-materialx и readthedocs и поддерживает плагин autorefs. Единственная зависимость — mkdocs.

Добавьте плагин в конец списка plugins в 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

    Добавьте print-site в конец списка плагинов в mkdocs.yml

  3. 3

    Откройте на сайте /print_page/ или print_page.html, чтобы просмотреть объединённую страницу для печати

Что важно знать

  • Экспорт страницы для печати в PDF зависит от функции печати в браузере.

В подборках

Темы

Частые вопросы

Что такое 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 — 4 нояб. 2026 г..
Для чего можно использовать mkdocs-print-site-plugin?
Подготовка полной офлайн-версии документации проекта в формате PDF Распространение документации в виде одного отдельного HTML-файла Создание руководств для печати на основе сайта документации на MkDocs
Как установить mkdocs-print-site-plugin?
Установите плагин с помощью pip: pip3 install mkdocs-print-site-plugin Добавьте print-site в конец списка плагинов в mkdocs.yml Откройте на сайте /print_page/ или print_page.html, чтобы просмотреть объединённую страницу для печати
Где скачать mkdocs-print-site-plugin?
Исходный код и инструкции по установке — на GitHub: https://github.com/timvink/mkdocs-print-site-plugin

Описание создано ИИ на основе README проекта. Статистика GitHub обновляется ежедневно.

Похожие проекты

Бесплатная открытая вики, которую постоянно обновляют: в ней разбираются темы спортивного программирования — от базовых алгоритмов до продвинутых (OI и ICPC).

27,1 тыс.+51 за неделю4,7 тыс.TypeScriptБез лицензииОбновлён 8 часов назад

Платформа с открытым исходным кодом для автоматической сборки, версионирования и размещения документации из Git-репозиториев с поддержкой Sphinx и MkDocs.

8,4 тыс.+1 за неделю3,7 тыс.PythonMITАктивно поддерживаетсяОбновлён вчера