MarkdownをPDFに変換する実践ガイド

PDF向けにMarkdownを準備する

読みやすいPDFの土台は、読みやすいMarkdownです。文書タイトルにH1、主要章にH2、その下にH3を使い、リスト、表、引用、コードブロックの前後へ空行を入れます。レンダラーが各ブロックを正しく認識しやすくなります。

リンクは「こちら」ではなく、リンク先の内容が分かる文字列にします。画像には代替テキストを付け、URLがログイン不要で取得できるか確認します。コードは言語名をコードフェンスの後へ書くと、対応するレンダラーで読みやすく表示されます。

• H1は文書タイトル、H2は主要章、H3は章内の項目にする
• 表の列数とセル内の文章を必要最小限にする
• 長いURLを本文へ直接並べず、説明的なリンク文字を使う
• コードフェンスに言語名を付ける
• 外部画像のURLと代替テキストを確認する

MarkdownからPDFを生成する

入力とプレビューは内容確認、ダウンロード後のPDFはページ確認という役割分担にします。

1. ツールを開くMarkdownを貼り付けるか、.mdまたは.txtファイルを開きます。
2. 画面で内容を確認見出し、リスト、表、コード、画像の読み込みを確認します。
3. PDFをダウンロードA4縦向きのPDFを生成します。
4. 実ファイルを確認改ページ、表幅、コードの折り返し、画像解像度を確認します。リンク先は必要に応じて本文へURLも記載します。

表、コード、画像を崩さないコツ

PDFで最初に問題になりやすいのは幅です。表の列が多い場合は、説明文を短くする、重要列だけ残す、一つの表を二つへ分ける方法が有効です。コードの長い一行は、画面では横スクロールできてもPDFでは折り返しや切れが起きます。サンプル用コードなら意味を変えない範囲で短くします。

外部画像はPDF生成時に取得できる必要があります。ログインが必要な画像、期限付きURL、外部アクセスを拒否する配信元は失敗することがあります。重要な画像は、最終公開工程で管理できる場所へ移してから参照します。

不自然な改ページを減らす

ページ末尾に見出しだけが残ると、次の内容がどこから始まるのか分かりにくくなります。見出しを短くし、直後の段落を極端に長くしないことで改善する場合があります。大きな空行をMarkdownへ入れて位置を調整する方法は、別のページ幅で崩れるためおすすめできません。

長い表やコードブロックは、途中で自然に分割できないことがあります。正式な報告書なら作成途中でPDFを生成し、実際のA4ページで問題を見つけるのが最も確実です。

• 見出しだけがページ下部に残っていないか
• 長い表が切れていないか
• コードの重要部分が読めるか
• 画像とキャプションが別ページに離れていないか
• 重要なリンクが動作するか

日本語PDFで見るポイント

日本語は英単語より文字単位で折り返しやすい一方、英数字が連続するURLやコードは横幅を超えやすくなります。見出しに日本語と長い英語製品名を並べる場合も、意図しない折り返しがないか確認します。

出力結果で日本語が四角い文字になっていないか、拡大しても十分に読めるかを確認します。現在の出力は画像型PDFなので、本文の検索やコピーを要件に含めないでください。

PDF、Word、HTMLの選び方

PDFは閲覧と印刷、Wordは共同編集、HTMLはWeb公開に向いています。原稿となるMarkdownを残しておけば、同じ内容を用途別に出力できます。

関連ツール