md2pdfのテーマ選択は、小さな決定に見えます。エクスポートボタンの上にある4つのラジオボタンにすぎません。しかし実際には、読者が内容に触れる前から、文書の読み心地を左右します。アカデミックで印刷された仕様書は論文のように見え、クリーンで印刷されたクライアント提案書はリポジトリのダンプのように見えます。正しいテーマとは、読者の期待に合うテーマです。
4つのテーマはすべて同じMarkdownをレンダリングします。違いは書体、配置、コードの扱い、表のスタイル、リンクの色、そして見出しにどれだけ視覚的な構造を加えるかです。どのテーマも透かし、表紙、ロゴを追加しません。内容はあなたのものです。
テーマは単なる色替えではなく、印刷用スタイルシート
各テーマは、プレビューシートに適用され、印刷出力にも引き継がれるCSSルールのセットです。つまりテーマは次に影響します。
- 見出し、本文、表、コードに使うフォント。
- 本文を左揃えにするか両端揃えにするか。
- 見出しの罫線の色と太さ。
- コードブロックとインラインコードの背景。
- 表ヘッダーの塗りと枠線の色。
- プレビューでのリンク色、およびPDFが保持する場合のエクスポートファイル内のリンク色。
印刷用スタイルシートはページ分割のヒントも処理します。コードブロック、表、引用、画像はできるだけ途中で分割されないようにし、見出しがページ末尾に取り残されないようにします。
比較の前に1つ実用的な注意点があります。コードブロックの塗りと表ヘッダーの色を残したい場合は、ブラウザの印刷ダイアログで背景のグラフィックを有効にしてください。無効でもPDFは読めますが、ビジネスとダークは構造の一部を失います。この選択はアプリではなく印刷ダイアログ側にあります。
クリーン:技術文書の既定
クリーンはニュートラルな選択肢です。アプリのUIと同じサンセリフ系フォントを文書全体に使い、白地に濃いグレーの文字、薄いグレーのコード背景です。見出しは細い罫線で区切られ、リンクは製品の他の場所と同じ青緑色を使います。
向いている用途:
- リポジトリのREADMEや技術仕様書。
- 社内のエンジニアリングドキュメント。
- コードの多い配布資料やランブック。
- 紙と同じくらい画面でも読まれる文書。
- 洗練よりも中立性が重要な監査スナップショット。
注意点:
- 非常に長い文章は平板に感じられることがあります。クリーンは効率的ですが、温かみはありません。
- 薄いコード背景は印刷時の背景グラフィックに依存します。無効にするとコードブロックは読めますが、本文との視覚的な分離が失われます。
- 小さい印刷サイズのサンセリフ本文は、長文ではセリフより読みにくいことがあります。
クリーンが最も安全な既定である理由は、特定の雰囲気を押し付けないからです。別のエンジニア向けにREADMEをエクスポートするなら、ここから始めてください。
ビジネス:レポート、提案書、クライアント向けの引き継ぎ
ビジネスは文書をよりフォーマルな雰囲気に変えます。全体にセリフ書体、太い罫線のネイビーの見出し、暗いコードブロック、色付きの表ヘッダーを使用します。結果はREADMEというよりレポートのように読めます。読者がクライアント、マネージャー、部門横断のステークホルダーである場合、まさにそれが狙いです。
向いている用途:
- クライアントへの引き継ぎやプロジェクト概要。
- 提案書、作業範囲記述書、レポート。
- デザインされた印象を持たせたいワークショップ資料。
- ポートフォリオの添付資料や応募サンプル。
- 図や表が文章と同じくらい重要な文書。
注意点:
- 暗いコードブロックは強い視覚要素です。短いコードスニペットが多い文書は縞模様のように見え始めることがあります。
- セリフ書体と両端揃えに近い単語間隔のため、長いURLやコード識別子が目立ちます。コード行は短く保ってください。
- ここでは背景グラフィックが重要です。無効にすると、暗いコードブロックは単なるブロックになり、表ヘッダーの色味も失われます。
- ビジネスは編集の代わりではありません。ビジネスで出力した生の変更履歴は、やはり生の変更履歴のように読めます。
外部向け文書では、ビジネスが通常はより良い第一印象を与えます。PDFが、後回しにされたエクスポートではなく、読者のために用意されたものであることを示します。
アカデミック:長文ドキュメントとコース資料
アカデミックはセリフ書体、両端揃えの本文、より温かく軽いコード表現を使用します。段落が両端揃えでも構造を読み取れるよう、見出しは左揃えのままです。全体の印象は製品ページというより、コースリーダーや論文に近くなります。
向いている用途:
- コースパック、読書資料、講義ノート。
- 論文や研究レポート。
- コードブロックが少ない長文ドキュメント。
- 助成金申請や学術ポートフォリオ。
- 読者が流し読みではなく通読することを期待する文書。
注意点:
- 両端揃えのテキストは、長いURL、コード識別子、技術用語の周囲に広い隙間を作ることがあります。長いリンクは参照形式のリンクに分けるか、リストに移してください。
- コードブロックは読めますが、ビジネスより視覚的に控えめです。これは意図的です。アカデミックはコードを主役ではなく、補助的な資料と位置づけています。
- 列が多い表はA4で窮屈になることがあります。列数を減らすか、詳細を本文に移してください。
- アカデミックは簡単なセットアップガイドには向きません。この形式は「最初から最後まで読む」ことを示しますが、ランブックは通常流し読みされます。
文書に参考文献のようなセクションがある場合、アカデミックのタイポグラフィはしっくりきます。アプリは引用を整形しないため、参考文献セクションはMarkdown内に保持してください。
ダーク:画面優先のレビュー、印刷しても安全な出力
ダークは異色の存在です。まず画面上で快適に読めるよう設計されています。暗いネイビーの背景、明るい文字、より鮮やかなリンク色です。印刷時には、印刷用スタイルシートが白い背景、黒い文字、黒いリンク、明るいコードブロックを強制します。PDFが暗い画面テーマを紙に持ち込むことはありません。
向いている用途:
- エクスポート前に長いREADMEを画面でレビューする。
- 夜間や薄暗い環境での読書。
- 白いページの視覚的なノイズなしで、文書の読み心地を確認する。
- ダークモードのツールを好むチームからPDFを生成する。
注意点:
- 画面で見えるものとPDFの結果は同じではありません。必ずエクスポートしたファイルを開き、明るい印刷結果を確認してください。
- ダークは外部向け文書のブランドテーマではありません。クライアントはPDFがプレビューではなく印刷出力に合うことを期待します。
- ブラウザが背景を印刷する設定でも、印刷用スタイルシートは暗い面を上書きします。ただし、コードブロックについては目視での確認が必要な場合があります。
- テーマの画面コントラストは、弱いソース構造を隠すことがあります。見出しレベルを飛ばした文書も雰囲気よく見えますが、構成が良くなるわけではありません。
ダークは、最終文書の4つ目の視覚的アイデンティティではなく、印刷しても安全な逃げ道を備えた読書モードと考えてください。
横並び比較
| クリーン | ビジネス | アカデミック | ダーク | |
|---|---|---|---|---|
| 本文の書体 | サンセリフ | セリフ | セリフ、両端揃え | 画面ではサンセリフ、印刷では細め |
| 見出しの扱い | 細い罫線 | ネイビーの罫線 | 左揃えのセリフ | 暗い背景に明るい罫線、印刷対応 |
| コードブロック | 薄いグレー | 暗いネイビー | 温かみのある明るい色 | 画面では暗色、印刷では明るく |
| 表ヘッダー | ニュートラル | 青みがかった色 | ニュートラル | 画面では暗色、印刷では明るく |
| リンク色 | 青緑 | 青 | 黒 | 画面では鮮やかな青、印刷では黒 |
| 最適な読者 | エンジニア | クライアント、マネージャー | 研究者、学生 | 画面で読む作成者 |
| 最適な文書 | 仕様書、README、ランブック | レポート、提案書、配布資料 | 論文、コースパック | レビュー用コピー |
この表は出発点であり、規則ではありません。技術系のクライアントがクリーンを好むこともあります。デザイン意識の高いエンジニアリングチームがビジネスを好むこともあります。文書の目的は、そのカテゴリより重要です。
テーマとエクスポート全体の関係
テーマは印刷結果の一部にすぎません。次の相互作用は確認する価値があります。
目次。 目次は文書の書体とリンク色を継承します。ビジネスではネイビーの見出しと青いリンクにより、レポートの目次のように感じられます。アカデミックでは論文のアウトラインのように読めます。目次は見出しが3つ以上ある文書に生成され、短い文書ではオフにできます。
コードブロック。 クリーンとアカデミックは明るいコード背景、ビジネスは暗いブロック、ダークは画面では暗いブロック、印刷では明るいブロックを使います。色よりも長い行のほうが大きな問題です。120文字の行はテーマに関係なくあふれます。
表。 ビジネスは色付きのヘッダーを加え、クリーンとアカデミックはニュートラルのままです。幅の広い表は最もよくある印刷の失敗です。表が5〜6列を超える場合は、印刷倍率を下げるのではなく、分割するかソースのフォントサイズを小さくすることを検討してください。
画像とバッジ。 テーマは画像のレンダリングを変えませんが、周囲の余白を変えます。ビジネスのセリフ本文はスクリーンショットを図のように感じさせ、クリーンのサンセリフ本文はドキュメントのように感じさせます。壊れた画像はプレビューで示され、エクスポートを中断しません。
リンク。 クリーンとビジネスは青いリンク、アカデミックは黒、ダークは画面では鮮やかな青、印刷では黒を使います。PDFをグレースケールで印刷する場合、色の違いは消えるため、色に頼らずリンクテキストを説明的にしてください。
改ページ。 印刷用スタイルシートは、コードブロック、表、引用、画像ができるだけ要素の途中で分割されないようにし、見出しを後続の内容と一緒に保ちます。この動作はテーマ共通ですが、長い文章でページ遷移が多いアカデミックではより重要です。
30秒で選ぶ
次の簡単な判断フローに従ってください。
- 読者は、コマンドやコードを探すエンジニアですか? クリーンを選びます。
- 読者は、レポートを期待するクライアント、マネージャー、レビュアーですか? ビジネスを選びます。
- 文書は、コードブロックの少ない長文ですか? アカデミックを選びます。
- 主に画面で読み、後からエクスポートしますか? ダークを選び、その後PDFを確認します。
- まだ迷いますか? クリーンを選びます。文書を最も誤解させにくい選択です。
効果的な確認方法:候補の2つのテーマで最初の2ページをエクスポートし、スマートフォンで読んでみてください。小さな画面と素早い流し読みに耐えるテーマが、通常は正解です。
テーマより重要なエクスポート前の確認
どのテーマでも解決できないものがあります。
- 見出し階層。 主要セクションには
##、サブセクションには###を使います。レベルを飛ばすと目次が混乱します。 - コード行の長さ。 可能な限り、行はおよそ80〜90文字未満に保ちます。
- 表の幅。 列を減らす、ラベルを短くする、表を分割する。
- 画像パス。 リポジトリ相対の画像にはリポジトリ取得が必要です。貼り付けたMarkdownには絶対URLが必要です。
- 機密テキスト。 変換はローカルですが、PDFは転送できます。
- ページサイズ。 A4とレターではページ分割が異なります。受け取る人が印刷するほうを選んでください。
- 背景のグラフィック。 コードブロックの塗りや表ヘッダーがデザイン上重要な場合は有効にしてください。
推奨
ほとんどのREADMEエクスポートでは、クリーンが適切な既定です。中立で読みやすく、文書を実際以上に見せかけません。PDFがエンジニアリング部門外への成果物ならビジネスを使ってください。文書を文章として読ませたいならアカデミックを使ってください。最終的な明るいPDFを作る前に快適なレビューをしたいならダークを使ってください。
テーマは読者へのシグナルです。目的に合うシグナルを選び、残りの労力は、明確な導入、合理的な見出し構造、実際に表示される画像といった内容に費やしてください。これらの選択はどのテーマでも通用します。
完全なエクスポート手順はGitHubのREADMEをPDFに変換する方法をご覧ください。読者層別の準備はREADMEをPDFにする7つの実用的な活用例をご覧ください。
自分だけのREADME PDFを作る
無料、ログイン不要、そしてすべてクライアントサイド。