timvink/mkdocs-print-site-plugin

これは何？

主な機能

• 01サイト内の全ページを1つの文書にまとめた印刷用ページを追加
• 02ブラウザーの印刷ダイアログからPDFに出力、または単体HTMLとして出力
• 03PDFのページ番号設定と、オプションの表紙に対応
• 04mkdocs-material、mkdocs-materialx、readthedocsの各テーマに対応
• 05autorefsプラグインをサポート
• 06依存関係はmkdocsのみ

ユースケース

• プロジェクトのドキュメントサイト全体を、オフラインで読めるPDFとして提供する
• ドキュメントを単体のHTMLファイルとして配布する
• MkDocsベースのドキュメントサイトから印刷用マニュアルを作成する

クイックスタート

1. 1

   pip でプラグインをインストールします

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

   mkdocs.yml のプラグイン一覧の末尾に print-site を追加します

3. 3

   サイトで /print_page/ または print_page.html を開くと、まとめて印刷できるページが表示されます

使う前に知っておきたいこと

• !印刷ページの PDF へのエクスポートには、ブラウザーの印刷機能を使用します。

収録されている特集

トピック

よくある質問

mkdocs-print-site-plugin とは？

サイト内の全ページをまとめた印刷用ページを追加し、PDFや単体HTMLとして簡単に出力できるMkDocsプラグイン。 mkdocs-print-site-pluginは、ドキュメント向けのPython製静的サイトジェネレーターMkDocsのプラグインです。サイト内のすべてのページを1つの文書にまとめたページを追加し、ドキュメント全体を1つの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 のプラグイン一覧の末尾に print-site を追加します サイトで /print_page/ または print_page.html を開くと、まとめて印刷できるページが表示されます

mkdocs-print-site-plugin はどこで入手できますか？

ソースコードとインストール手順は GitHub にあります：https://github.com/timvink/mkdocs-print-site-plugin