マークダウンで PDF ドキュメントを作る
日々 Word やら Excel やらでドキュメントを作っていると、差分管理がめんどくさすぎて発狂しそうになります。 Git で管理するのも大変です。 それに AI に食わせるのもめんどくさい。
ということで、 A4 サイズの PDF ドキュメントを生成できるマークダウンのリポジトリテンプレートを作ってみました。 社内のドキュメント作成で、 Word から脱却できちゃいます。 マークダウンを PDF ファイルに変換できるので、社内のドキュメント配布にも対応できます。
GitHub のリポジトリテンプレートとして作成してあるので、インポートしてそのまま使い始めることができます。
サンプル
マークダウンを PDF 化したときのサンプルをいくつか紹介します。
表紙
以下のようなデザインの表紙が既定で作れます。 CSS でデザインのカスタマイズも可能です。 なんだかんだ表紙が求められるケースは多いので、あって損はないと思います。
目次
目次ページを作ることもできます。 Markdown all in one | Table of contents の機能を活用すると、ほぼ自動生成できます。
コードブロック
コードブロックを差し込むこともできます。 言語指定すれば、ハイライトすることも可能です。
画像ファイル
png や svg などの画像を差し込むことができます。
mermaid ダイアグラム
mermaid 構文を使って画像を差し込むこともできます。
テーブル
簡単に情報をまとめたいときにテーブルは便利です。 ただ、大量の情報をまとめるのであれば、テーブルではない表現を用いたほうが良いと思います。
箇条書き
箇条書きは、インデントをつけると階層化できます。
タスクリスト
チェックボックスを持つ箇条書き（タスクリスト）が作れます。 PDF 上でチェックボックスのオン / オフを切り替えることはできません。
番号付きリスト
番号付きリストも、インデントをつけると階層化できます。
引用
他の文献から引用するときに使います。
アラート
全部で 16 種類のアラートが利用できます。
アラートの種類によって、デザインが変わります。
まとめ
会社で作成するドキュメントを、このテンプレートを活用して作るように変えはじめました。 プルリクエストを使ってドキュメントレビューができるので、いろいろはかどります。 各種 Lint が強制されるのも良い点かなーと思います。
マークダウンは、生成 AI が読み取りやすい形式だと思います。 Word や Excel 方眼紙からマークダウンへの転換によって、 AI 対応の業務が実現できるかもしれませんね。
今回はマークダウンを使って、 A4 サイズの PDF ドキュメントを作成するための GitHub リポジトリテンプレートを紹介しました。 MITライセンスで公開しているので、ご自由に活用してください。 （ただし自己責任で）
