pfnet-research/pfpdf
pfnet-research/pfpdf has 241 GitHub stars and 3 forks. GitHot measured 0 stars in 24 hours. Last checked 2026-11-18 03:38 UTC. Last push 2026-11-14.
計測したスター増加
- 24時間
- 0
- 7日間
- 履歴を収集中
- 15日間
- 履歴を収集中
- 1か月
- 履歴を収集中
期間ごとの純増数です。期間は重複しており、日別の値ではありません。未計測の値は空欄です。スター数は注目度の指標であり、品質の保証ではありません。
概要
PDF typesetting tool for Markdown files
開発ツールREADME.ja.md
オリジナルpfpdf
pfpdfは、Markdown文書から日本語組版に対応したPDFを生成するコマンドラインツールです。表紙や目次を付けた技術レポート、マニュアルなどを作れます。表・数式・コードハイライトにも対応しています。
左から、pfnの表紙と本文、notebookの表とコードの例です。テンプレートギャラリーでは、同梱する7種類すべての出力を確認できます。
最初のPDF
Node.js 22.12.0以上とnpmを用意します。下のnpxコマンドでpfpdfを取得して実行できます。
次の内容をdocument.mdに保存します。先頭の---で囲んだ設定欄(フロントマター)で、タイトルとテンプレートを指定しています。
---
title: 技術レポート
template: pfn
---
# 概要
これは**pfpdf**で作るPDFです。
document.mdを保存したディレクトリーで、次のコマンドを実行します。
npx @pfnet-research/pfpdf@latest --input document.md --output document.pdf
初回はnpmパッケージと描画用ブラウザーのChromiumを取得するため、インターネット接続が必要です。Chromiumのダウンロードには数百MBの通信が発生することがあります。2回目以降は保存済みのブラウザーを再利用します。PDFの描画にはVivliostyle CLIを使います。
生成されたdocument.pdfを開くと、タイトルの入った表紙、目次、本文を確認できます。
CIや繰り返し実行するビルド手順では、@latestを@0.2.1のような指定に置き換え、バージョンを固定してください。
複数ファイルの結合
章ごとにファイルを分ける場合は、chapters/などのディレクトリーにまとめ、--inputに指定します。
npx @pfnet-research/pfpdf@latest --input chapters --output report.pdf
直下の.mdファイル(拡張子は小文字)をファイル名順に結合します。00_title.md、01_intro.md、02_results.mdのように番号を付けると、読む順序を指定できます。共通の設定は、最初のファイルの先頭にフロントマターとしてまとめて書いてください。章の間のリンク、改ページ、画像のパスは文書の構成を参照してください。
テンプレートと記法
見た目はフロントマターのtemplateで選びます。一度だけ別のデザインを試す場合は、コマンドに--template notebookなどを追加してください。コマンドライン引数がフロントマターより優先されます。
各テンプレートの既定フォントは、日本語フォントを含めて同梱しています。独自のテンプレートやロゴ、手元のフォントの指定方法はテンプレートとアセットにまとめています。
- 表・タスクリスト:GitHub Flavored Markdown(GFM)に対応しています。取り消し線や、日本語の句読点・括弧に隣接する強調も扱えます。
- 数式・コード・図:TeXの数式、コードハイライト、Mermaidを使えます。描画に必要なアセットは同梱しています。
- 引用・参考文献:BibTeXファイルから参考文献一覧を生成し、本文の引用番号から各文献へリンクします。
動作環境とトラブルシューティング
CIでは、次の4環境で実際のブラウザーを使ったPDF生成を検証しています。
- macOS aarch64(Apple Silicon)
- Linux x86_64
- Windows x86_64
- Linux aarch64
LinuxではChromiumの実行にシステムライブラリーも必要です。変換に失敗したときは、次のコマンドで環境を診断してください。
npx @pfnet-research/pfpdf@latest --doctor
Node.js、ブラウザー、フォントなどの問題と対処方法が表示されます。Linuxの環境設定や、その他の変換エラーへの対処はトラブルシューティングを参照してください。
入力文書の取り扱い
入力には信頼できる文書を使ってください。pfpdfは入力のHTMLをそのまま描画し、スクリプトも実行します。文書からは、pfpdfが読み取れるローカルファイルや外部URLにアクセスできます。
リモートの画像などを参照する場合は、変換時に取得できる必要があります。入力文書を信頼する前提と脆弱性の報告方法は、セキュリティーポリシーに記載しています。
ドキュメントと開発
| 文書 | 日本語 | 英語 |
|---|---|---|
| チュートリアル:使い方と文書の例 | 日本語 | English |
| 設計書:仕様と設計判断 | 日本語 | English |
仕様と使い方は日本語版を基準とし、英語版はその翻訳です。各GitHub Releaseには4文書のPDFを添付しています。設計書やチュートリアルのPDFを手元で生成したり、開発に参加したりする場合は、コントリビューションガイドに従って環境を用意してください。文書のPDFはmake docsで生成できます。
コマンドライン引数の一覧はCLIの使い方を参照してください。
ライセンス
pfpdfのコードはMIT Licenseで公開しています。依存するソフトウェアや同梱アセットには個別のライセンスが適用されます。Vivliostyle CLIのAGPL-3.0を含む一覧は、第三者ライセンスに記載しています。


