PDF ドキュメント生成
MiniPrem インストールから、ブランディング・目次・カテゴリーフィルターを備えたプロフェッショナルな PDF ドキュメントを生成します。
概要
PDF ジェネレータースクリプトは、MiniPrem の Markdown ドキュメントをプロフェッショナルにフォーマットされた PDF ドキュメントに変換します。主な機能は以下のとおりです。
カバーページ: ロゴとドキュメントタイトル
目次: クリック可能なページ参照
カテゴリーフィルター: 特定のトピックのみを対象にドキュメントを生成
シンタックスハイライト: コードブロックに対応
プロフェッショナルなスタイリング: 印刷・共有に最適化
クイックスタート
プロジェクトのルートディレクトリから、次のコマンドを実行してください。
./scripts/generate-docs-pdf.shこれにより、次のパスに完全なドキュメント PDF が生成されます。
docs/MiniPrem-Documentation.pdf使い方
オプション
-c, --category
カテゴリーでフィルター（デフォルト: all）
-o, --output
出力 PDF のファイルパス
-t, --title
カスタムドキュメントタイトル
--no-toc
目次をスキップ
--no-cover
カバーページをスキップ
--no-watermark
ページの透かしをスキップ
-v, --verbose
詳細出力を有効化
-h, --help
ヘルプメッセージを表示
カテゴリー
特定のトピックに絞ってドキュメントを生成できます。
docker
Docker デプロイガイドおよびローカルセットアップ
kubernetes
Kubernetes / EKS / AKS の本番デプロイメント
services
サービス設定（Flowise、vLLM、Renny など）
api
API リファレンスドキュメント
advanced
高度なトピック（テレメトリ、トラブルシューティング）
all
サイドバーの順序ですべてのドキュメント（デフォルト）
例
ドキュメント全体を生成する
Kubernetes ドキュメントのみを生成する
Docker と Kubernetes のドキュメントをまとめて生成する
カスタム出力パスと詳細ログを指定する
カバーページと透かしなしで生成する
出力
生成される PDF には以下が含まれます。
カバーページ - ロゴ、ドキュメントタイトル、生成日
目次 - クリック可能なナビゲーションとページ番号
ドキュメント本文 - シンタックスハイライト付きの選択されたすべてのドキュメント
ページフッター - 著作権表示とページ番号
デフォルトの出力先
要件
Python
Python 3.8 以上が必要です。スクリプトは初回実行時に自動的に仮想環境を作成し、依存関係をインストールします。
システムライブラリ
WeasyPrint は PDF レンダリングのためにシステムライブラリを必要とします。
macOS:
Ubuntu / Debian:
トラブルシューティング
WeasyPrint のインストールが失敗する
ライブラリが見つからないというエラーが表示される場合は、ご利用の OS 向けに上記のシステム依存関係をインストールしてください。
PDF が生成されない
Python 3.8 以上がインストールされていることを確認します:
python3 --version詳細を確認するため、verbose フラグ付きで実行します:
./scripts/generate-docs-pdf.sh -vdocs ディレクトリが存在することを確認します:
ls docs/
フォントが欠落している
この PDF はシステムフォントを使用しています。テキストが正しく表示されない場合は、標準のシステムフォントがインストールされていることを確認してください。
最終更新