VS Code で Markdown を PDF に変換する方法
VS Code のエディターやプレビューから Markdown を PDF に書き出す手順を紹介します。拡張機能を使わず、文字を選択できる PDF をブラウザーで保存する方法もあります。
VS Code 標準の Markdown プレビューには、PDF に書き出すコマンドがありません。エディターから直接書き出すなら Markdown PDF、プレビューを見ながら書き出すなら Markdown Preview Enhanced が使えます。拡張機能を追加せずに済ませたい場合は、ブラウザーで変換できます。
方法 A:Markdown PDF で編集中のファイルを書き出す
- VS Code の拡張機能ビューで
yzane.markdown-pdfを検索し、Markdown PDF をインストールします。 - 対象の
.mdファイルを開き、F1またはCtrl+Shift+P(Mac は⌘⇧P)でコマンドパレットを開きます。 exportと入力し、markdown-pdf: Export (pdf)を選びます。エディター内を右クリックしても同じ項目を選べます。ほかにhtml、png、jpeg、allがあります。
この拡張機能は Puppeteer 経由で Chromium を使って描画します。まず markdown-pdf.executablePath で指定したブラウザーを使い、指定がなければインストール済みの Chrome、Edge、Chromium を探します。見つからなければ初回に Chromium をダウンロードします。自動ダウンロードは markdown-pdf.chromium.autoDownload を false にすると無効になります。
用紙の初期値は A4 です。たとえばレターサイズの配布資料で上下左右に 1.5 cm の余白を取る場合は、settings.json に次のように指定します。
{
"markdown-pdf.format": "Letter",
"markdown-pdf.margin.top": "1.5cm",
"markdown-pdf.margin.bottom": "1.5cm",
"markdown-pdf.margin.left": "1.5cm",
"markdown-pdf.margin.right": "1.5cm"
}
ヘッダーとフッターを表示するには markdown-pdf.displayHeaderFooter を有効にします。内容はそれぞれ markdown-pdf.headerTemplate と markdown-pdf.footerTemplate で指定できます。保存先には markdown-pdf.outputDirectory、独自の CSS には markdown-pdf.styles を使います。最近のリリースでは、直接記述した HTML は既定でサニタイズされます。
方法 B:Markdown Preview Enhanced のプレビューから書き出す
- Chrome と、拡張機能 Markdown Preview Enhanced(
shd101wyy.markdown-preview-enhanced)をインストールします。 - Markdown ファイルを開き、
Markdown Preview Enhanced: Open Previewを実行します。横にプレビューを開くにはCtrl+K V(Mac は⌘K V)を使います。 - プレビュー内を右クリックし、
Chrome (Puppeteer)を選んでから PDF を書き出します。
この文書を A4 縦向きにするには、Markdown ファイルの先頭に次の YAML フロントマターを置きます。
---
puppeteer:
landscape: false
format: "A4"
---
方法 C:拡張機能を使わずブラウザーで変換する
ConverterTo の Markdown から PDF への変換ツールでファイルを選び、用紙を A4 またはレターサイズに設定します。変換はブラウザー内で完結し、用途に応じて出力方法を選べます。
- 画像ベースの PDF を作成すると、行と行の間で改ページした PDF をダウンロードできます。各ページが画像になるため、文字は選択できません。
- PDF に印刷(文字を選択可能) を押すとブラウザーの印刷画面が開きます。そこから PDF として保存すれば、読み手が本文を選択してコピーできます。
用途別の選び方
| 比較項目 | Markdown PDF | Markdown Preview Enhanced | ConverterTo |
|---|---|---|---|
| 準備 | 拡張機能と Chromium 系ブラウザー | 拡張機能と Chrome | ブラウザーでツールを開く |
| 文字の選択 | 通常は可能 | 通常は可能 | 印刷から保存すれば可能 |
| 独自の CSS | markdown-pdf.styles | プレビューのスタイルを調整 | 既定のスタイルを使用 |
| 準備後のオフライン利用 | 素材がローカルにあれば通常は可能 | 素材がローカルにあれば通常は可能 | ツールや外部画像の読み込みに接続が必要 |
| 画像の相対パス | 参照先があれば通常は表示可能 | 参照先があれば通常は表示可能 | 画像は絶対 URL で指定 |
| 向いている用途 | 同じ設定で繰り返し書き出す | 普段使うプレビューから書き出す | 一度だけ PDF にする |
うまくいかないとき
- プロキシで Chromium をダウンロードできない。 VS Code の
http.proxyを設定するか、markdown-pdf.executablePathでインストール済みのブラウザーを指定します。 - 画像が表示されない。
images/chart.pngなら、Markdown ファイルのあるフォルダーを起点にパスを確認します。ブラウザーのツールにファイルを一つ渡しても隣の画像は参照できないため、画像を絶対 URL で指定してください。外部画像は配信元から取得され、配信元には利用者の IP アドレスが伝わります。 - 日本語、中国語、韓国語の文字が四角になる。 書き出しに使う端末に、その文字を収録したフォントがあるか確認します。
- 章の先頭で改ページしたい。 Markdown PDF では、見出しの直前に
<div class="page"></div>を単独の行として挿入します。
よくある質問
保存するたびに PDF を書き出せますか? Markdown PDF は markdown-pdf.convertOnSave を有効にして VS Code を再起動します。Markdown Preview Enhanced はフロントマターの最上位に export_on_save: { puppeteer: true } を追加します。
Web ページや編集用の文書として渡すには? Web ページにするなら Markdown から HTML への変換、編集できる文書にするなら Markdown から Word への変換が使えます。