md2pdf プログラム仕様
MarkdownファイルをPDFに変換するユーティリティ。
- 概要:
MarkdownファイルをPDFに変換するユーティリティモジュールです。
- 詳細説明:
MarkdownテキストをHTMLに変換し、さらにFPDFライブラリを使用してPDFドキュメントとして レンダリングします。日本語フォントの自動検出や、コードブロック、箇条書き、見出しなどの 基本的なMarkdown要素のサポートを含みます。
- 関連リンク:
md2pdf_usage
- class md2pdf.PDF(orientation: str | PageOrientation = PageOrientation.PORTRAIT, unit: str | float = 'mm', format: str | tuple[float, float] = 'A4', font_cache_dir: Literal['DEPRECATED'] = 'DEPRECATED', *, enforce_compliance: str | DocumentCompliance | None = None)
ベースクラス:
FPDF- 概要:
MarkdownコンテンツをPDFとしてレンダリングするためのFPDF拡張クラス。
- 詳細説明:
FPDFの基本機能に加え、H1、H2、段落、箇条書き、コードブロックといった Markdownの要素をPDFに適切に描画するためのカスタムメソッドを提供します。 ページのヘッダーとフッターは表示されません。
- bullet(text: str)
- 概要:
箇条書き項目をPDFに書き込みます。
- 詳細説明:
ビュレット記号を先頭に付加し、残りのテキストを右にインデントして描画します。 テキストが長すぎてFPDFのmulti_cellで処理できない場合、 insert_soft_breaks関数を使用してゼロ幅スペースを挿入し、折り返しを試みます。
- 引数:
- param text:
箇条書き項目のテキスト。
- type text:
str
- code_block(code: str)
- 概要:
コードブロックをPDFに書き込みます。
- 詳細説明:
コードブロックは背景色がグレーのボックスで囲まれ、コードがその中に表示されます。 コードの行が長い場合、insert_soft_breaks関数を使用してゼロ幅スペースを挿入し、 適切に折り返されるようにします。
- 引数:
- param code:
コードブロック内のテキスト。
- type code:
str
- 概要:
ページのフッターを生成しないようにオーバーライドします。
- h1(text: str)
- 概要:
H1見出しをPDFに書き込みます。
- 詳細説明:
指定されたテキストを大きなフォントサイズで描画し、前後に余白を追加します。
- 引数:
- param text:
H1見出しのテキスト。
- type text:
str
- h2(text: str)
- 概要:
H2見出しをPDFに書き込みます。
- 詳細説明:
指定されたテキストをH1よりわずかに小さいフォントサイズで描画し、前後に余白を追加します。
- 引数:
- param text:
H2見出しのテキスト。
- type text:
str
- header()
- 概要:
ページのヘッダーを生成しないようにオーバーライドします。
- md2pdf.extract_code_blocks(html: str)
- 概要:
HTML文字列からpreとcodeタグ形式のコードブロックを抽出しプレースホルダに置換します。
- 詳細説明:
FPDFがHTMLのコードブロックを直接処理できないため、この関数はコードブロックのコンテンツを 一時的なリストに保存し、元のHTML内では@@@CODEBLOCK_N@@@という形式のプレースホルダに置き換えます。 これにより、HTMLの残りの部分が通常の段落として処理された後、コードブロックを個別にレンダリングできます。
- 引数:
- param html:
処理対象のHTML文字列。
- type html:
str
- 戻り値:
- returns:
プレースホルダに置換されたHTML文字列と、抽出されたコードブロックのリストのタプル。
- rtype:
tuple
- md2pdf.find_font_path(font_path=None)
- 概要:
システム上の日本語フォントのパスを検索します。
- 詳細説明:
指定されたフォントパスを最優先で確認し、その後、一般的なWindows、macOS、Linuxの 日本語フォントパスの候補を探索します。最初に見つかった既存のファイルのパスを返します。 これにより、異なるOS環境でも日本語が正しく表示されるようにします。
- 引数:
- param font_path:
ユーザーが指定したフォントファイルのパス。Noneの場合はデフォルトを検索します。
- type font_path:
str or None
- 戻り値:
- returns:
見つかったフォントファイルの絶対パス文字列、または見つからなかった場合はNone。
- rtype:
str or None
- md2pdf.html_to_pdf(html: str, output_filename: str, font_path=None)
- 概要:
HTML文字列をPDFファイルに変換します。
- 詳細説明:
HTMLを解析し、PDFクラスのメソッドを使用してコンテンツをレンダリングします。 事前にextract_code_blocksで抽出されたコードブロックは、この関数内で PDFのコードブロックとして特別に処理されます。また、日本語フォントの検出と設定も行われます。
- 引数:
- param html:
変換するHTML形式の文字列。
- type html:
str
- param output_filename:
出力するPDFファイルのパス。
- type output_filename:
str
- param font_path:
使用する日本語フォントファイルのパス。Noneの場合はデフォルトを検索します。
- type font_path:
str or None
- 例外:
- raises FileNotFoundError:
日本語フォントが見つからない場合。
- md2pdf.insert_soft_breaks(s: str, hard_chunk=60) str
- 概要:
改行できない長大トークンにゼロ幅スペースを挿入して折り返しを許可します。
- 詳細説明:
URLやファイルパスなどの連続した文字の塊、または指定されたhard_chunkよりも 長いトークンに対して、ゼロ幅スペース(U+200B)を挿入することで、PDFレンダリング時に テキストが適切に折り返されるようにします。これにより、レイアウトの崩れを防ぎます。
- 引数:
- param s:
処理対象の文字列。
- type s:
str
- param hard_chunk:
ゼロ幅スペースを挿入する最小の文字塊の長さ。
- type hard_chunk:
int
- 戻り値:
- returns:
ゼロ幅スペースが挿入された文字列。
- rtype:
str
- md2pdf.md_to_html(md_text: str) str
- 概要:
MarkdownテキストをHTMLに変換します。
- 詳細説明:
Python-Markdownライブラリを使用し、追加の拡張機能 (extra, fenced_code, tables)を有効にしてMarkdownテキストをHTML文字列に変換します。
- 引数:
- param md_text:
変換するMarkdown形式の文字列。
- type md_text:
str
- 戻り値:
- returns:
変換されたHTML形式の文字列。
- rtype:
str
- md2pdf.md_to_pdf(input_path, output_path=None, font_path=None)
- 概要:
MarkdownファイルをPDFに変換します。
- 詳細説明:
指定されたMarkdownファイルを読み込み、md_to_htmlでHTMLに変換後、 html_to_pdfで最終的なPDFファイルを作成します。 入力ファイルの存在チェック、空ファイルチェック、エラーハンドリングを行います。 出力パスが指定されない場合は、入力ファイル名と同じ名前で拡張子をpdfに変更して出力します。
- 引数:
- param input_path:
入力となるMarkdownファイルのパス。
- type input_path:
str
- param output_path:
出力するPDFファイルのパス。Noneの場合は入力ファイルパスから自動生成します。
- type output_path:
str or None
- param font_path:
使用する日本語フォントファイルのパス。Noneの場合はデフォルトを検索します。
- type font_path:
str or None
- 戻り値:
- returns:
変換に成功した場合は出力PDFファイルの絶対パス、失敗した場合はNone。
- rtype:
str or None