PDF Generate Plugin for MkDocs で MkDocs でビルドしたドキュメントを PDF 化する

MkDocs の PDF 可にはいくつか手段があります。

• MkDocs PDF Export Plugin Build Status
• wkhtmltopdfを使う

本記事では PDF Generate Plugin for MkDocs という MkDocs のプラグインでの PDF 化について紹介します。

PDF Generate Plugin for MkDocs

https://github.com/orzih/mkdocs-with-pdf

やってみる

前提条件

本記事での検証は以下の環境で行っています。
MkDocs はインストール済みの環境となります。

brew --version
Homebrew 3.0.1
Homebrew/homebrew-core (git revision 158dba; last commit 2021-02-15)

python3 --version
Python 3.9.1

pip3 --version
pip 21.0.1 from /usr/local/lib/python3.9/site-packages/pip (python 3.9)

mkdocs --version
mkdocs, version 1.1.2 from /usr/local/lib/python3.9/site-packages/mkdocs (Python 3.9)

実際に要求される環境についてはプラグインの Requirements を参照ください。

インストール

こちらに従って WeasyPrint をインストールします。

pip3 install WeasyPrint
brew install cairo pango gdk-pixbuf libffi

次にプラグイン本体をインストールします。

pip3 install mkdocs-with-pdf

準備ができました。

実行

mkdocs.yml にプラグインを設定します。

plugins:
    - with-pdf

この状態で以下のようにビルドを行うとビルドに合わせて PDF が出力されます。

ENABLE_PDF_EXPORT=1 mkdocs build

デフォルトでは pdf/document.pdf に PDF が出力されますが、設定で変更 可能です。

その他のカスタマイズについても README を参照ください。