頑張らないために頑張る

ゆるく頑張ります

VS CodeでMarkdownをPDFに自動で変換する

Posted at — May 15, 2019

はじめに

Markdownで記述したmdファイルは、エンジニア間ではそのまま利用することが多いように思います(GitHubなどにREADME.mdとしてアップするとか)。ところが、メールに添付したり印刷する等、外部へ持ち出す際はPDFに変換しておいた方がいろいろ安心。とくに「mdファイルって何?」みたいなお客さんにドキュメントを渡さないといけない場合とか・・・。

MarkdownをPDF化するのは、Pandocを利用する方法もあるのですが、ここではVisual Studio Code(以下、VS Code)の拡張機能である「Markdown PDF」を利用します。

環境

インストール

VS Codeにて、Ctrl+Shift+Xで拡張機能の検索窓に「Markdown PDF」と入力するか、上記のリンクをクリックします。検索結果から「Markdown PDF」を選択し、インストールします。Markdown PDFをインストールしてから、VS Codeで適当なMarkdownファイルを最初に開いた際、Chromiumのダウンロードが自動で始まります。ちなみに、なんでChromiumが必要かというと、Markdown PDFがPDF変換するのに利用しているから。

使い方

  1. PDF化したいMarkdownファイルを開く。
  2. F1キーを押すか、Ctrl+Shift+Pキーを押しコマンドパレットを表示させる。
  3. exportと入力すると下記のメニューが表示される。

    • markdown-pdf: Export (settings.json)
    • markdown-pdf: Export (pdf)
    • markdown-pdf: Export (html)
    • markdown-pdf: Export (png)
    • markdown-pdf: Export (jpeg)
    • markdown-pdf: Export (all: pdf, html, png, jpeg)

    この中からExport (pdf)を選択する。

  4. 少し待つと、Markdownと同一のフォルダーにPDFが生成される。

自動化

上記の使い方ではPDFへ変換するのに、毎回コマンドパレットを表示してコマンドを入力し、どのファイル形式でエクスポートするかを選択する必要があります。これを特定の変換先(今回はPDF)に限定して自動変換するよう設定します。

  1. 「ファイル」メニュー>「基本設定」>「設定」を選択するか、Ctrl+,で直接画面を開く。

  2. setting.jsonファイルを開いて下記のように設定する。

    "markdown-pdf.convertOnSave": true,
    "markdown-pdf.type": [
        "pdf"
    ],
  3. 設定内容を書き込んだらVS Codeを1度再起動する。

これで、Markdownファイルを編集し保存したタイミングで自動的にPDFへ変換するようになります。

注意

この拡張機能は変換したファイルの出力先を変更できないので、必ずMarkdownファイルが格納されているフォルダーと同じ場所に出力されます。また、出力先ファイル名も指定できないので、同一名のファイルが既存である場合は自動的に上書きします。

comments powered by Disqus