大規模なオープンソースリポジトリでは、ドキュメントが多数の階層ディレクトリに分散して配置されることが一般的です。手作業でファイルを検索、ダウンロードし、PDFに変換するのは多大な時間を要します。md2pdf を使用すれば、ブラウザ上でリポジトリのファイルツリーを直接探索し、必要なドキュメントのみを選択して出力できます。
本ガイドでは、md2pdfによるリポジトリツリーの解析方法、階層フォルダのナビゲーション、そして高精度なPDF生成に向けた準備手順を解説します。
GitHubリポジトリツリー解析の仕組み
公開リポジトリのURLを入力すると、md2pdfクライアントはGitHub公開APIを利用してGitツリーメタデータを取得します。リポジトリ全体のアーカイブをダウンロードするのではなく、ツリー表示に必要なメタデータのみをフェッチするため、軽快に動作します。
検出されたファイルは .md、.markdown、.mdown、.mkd などの対応拡張子でフィルタリングされ、ドキュメント以外のソースコードや画像はツリーから除外されます。これにより、必要な技術文書のみを一覧確認できます。
# Expected GitHub repository tree representation
docs/
├── architecture/
│ ├── overview.md
│ └── data-flow.md
├── guides/
│ ├── getting-started.md
│ └── deployment.md
└── api-reference.md階層フォルダのナビゲーション
複雑なソフトウェアプロジェクトでは、機能ごとにフォルダが分かれています。md2pdfのエクスプローラーインターフェースにより、ページを遷移することなくサブディレクトリを展開・確認できます。
- ノードの展開と折りたたみ: フォルダ名をクリックして表示・非表示を切り替えます。階層構造が維持されるため、現在地を見失いません。
- 相対パスの可視化: 完全な相対パスが表示されるため、各ドキュメントのリポジトリ内における位置づけが明確です。
- ファイル情報の確認: 変換処理を開始する前に、目的のMarkdownファイルが正しく存在しているかを確認できます。
複数ディレクトリにまたがるMarkdownファイルの選択
リポジトリ内のすべてのファイルを変換する必要はありません。md2pdfでは目的に応じた自由な選択が可能です:
- 個別選択: 異なるディレクトリにある特定のファイルのみにチェックを入れて、独自のドキュメントセットを構成します。
- フォルダ単位の一括切り替え: フォルダのチェックボックスをクリックすることで、配下のすべてのファイルを一括選択・解除できます。
- クロスディレクトリの統合:
docs/やtutorials/、ルートのREADME.mdを1つのまとまったドキュメントに結合できます。
クライアントサイドのセキュリティとAPI制限対策
md2pdfはすべてのAPIリクエストとファイル取得をブラウザ内で完結させます。リポジトリのコンテンツやトークンが外部アプリケーションサーバーに送信されることは一切ありません。
未認証リクエストの場合、GitHub APIにはIPアドレスあたり毎時60回の制限があります。md2pdfは再帰的Gitツリークエリを活用してリクエスト数を最小限に抑え、快適なブラウジングを提供します。
選択したツリーのPDF変換
目的のMarkdownファイルの選択が完了したら、変換ボタンをクリックします。個別のPDFファイルをまとめたZIPアーカイブとして出力するか、目次と通し番号が付与された1冊の統合PDFブックとして書き出すかを選択できます。
自分だけのREADME PDFを作る
無料、ログイン不要、そしてすべてクライアントサイド。