Marked2を使ってMarkdownからPDFを作る

2022-06-272022-10-06

Gitで管理しているドキュメントはWordやExcelで書くよりも、Markdownで書いた方が保守しやすく、更新が楽になります。

しかし、Markdownで作成するとGitLabなどのMarkdownをレンダリングしてくれるサイトから見るには良くても、外部配布向けにプリント機能でPDFにすると、今ひとつWordで作った方が見栄えがよくなるなぁと感じています。

そこで、Marked2というアプリを使ったPDFの作成方法を紹介します。

Marked2とは？

Marked2はMac用のアプリでMarkdownのビューワアプリです。Mac App Storeから購入するか、SETAPPのサブスク経由で利用可能です。私はSETAPPのサブスク経由で使用しています。

Marked2の設定

MarkedメニューのPreferencesから色々設定できます。私のお勧め設定は以下の通りです。

Styleタブ

Styleタブは、Default style:をGitHubに変更します。MarkdownがGitHubと同じスタイルでレンダリングされます。

Exportタブ

Print background colors and images, Use first H1 as fallback title, Indicate page breaks in previewをオンにします。

Indicate page breaks in previewをオンにすると、プレビュー上でページ区切りが分かるので、必要に応じて、ページ区切りを追加します。

Headers and FootersのTop Leftに%title、 Bottom Rightに%page/%totalを設定し、Include on first pageのHeaderとFooterをオンにします。

PDF化したときに、ヘッダーにドキュメントタイトル、フッターにページ番号が挿入されます。

PDFの作成

PDFを作成するには、FileメニューからExport As -> Save PDF (Paginated) を選択します。

Tips

Markedを使ってPDFを作るときのちょっとしたTipsを紹介します。

特定の場所でページを区切りたい

Markdownの中で、次のように書くと、そこで改ページが行われます。

<!--BREAK-->

目次を入れたい

PDFのしおりにはなってくれないのですが、ハイパーリンク付きの目次ページを生成できます。Markdownの中で次のように書いた場所に目次が生成されます。

<!--TOC-->

PreferencesウインドウのExportタブのPrint table of contentsオプションはオフで使用します。Print table of contentsオプションだと、強制的にドキュメントの先頭に生成されてしまうので、使い勝手が悪いです。

また、Page break afterオプションをオフにしても、次のようにとセットで使えば、目次専用ページを任意の場所に作れるので、使いやすいです。

<!--BREAK-->
## 目次

<!--TOC-->
<!--BREAK-->

よりも前に書いた見出しは目次の対象にならないので、目次に入れたくない項目はよりも手前に書きます。例えば、次のよう感じです。

# 動作確認結果

A.Hayashi

本資料は、動作結果についてまとめている。

## 改訂履歴

- 2022年6月27日　新規作成

<!--BREAK-->

## 目次

<!--TOC-->
<!--BREAK-->

## 動作環境

動作環境は以下の通り。

## Beta1での結果

Beta1では問題なし

これをMarkedでプレビューでのページ区切り表示有りでレンダリングすると次のようになります。