ドキュメント

[Python] markdownテキストをPDFに変換する方法

2025-01-18更新日: 2025-01-18

PythonでMarkdownテキストをPDFに変換するには、いくつかのライブラリを組み合わせて使用します。

一般的な方法として、まずmarkdownライブラリでMarkdownをHTMLに変換し、その後pdfkitやweasyprintなどのライブラリを使ってHTMLをPDFに変換します。

pdfkitを使う場合、wkhtmltopdfという外部ツールが必要です。

weasyprintは純粋なPythonライブラリで、外部ツールを必要としないため、手軽に利用できます。

目次から探す

MarkdownからPDFへの変換概要
必要なライブラリのインストール
markdownライブラリでMarkdownをHTMLに変換
pdfkitを使ってHTMLをPDFに変換
weasyprintを使ってHTMLをPDFに変換
応用例
まとめ

MarkdownからPDFへの変換概要

Markdownは、シンプルな記法で文書を作成できるフォーマットですが、PDF形式に変換することで、印刷や配布が容易になります。

Pythonを使用すると、Markdownファイルを簡単にPDFに変換することができます。

この記事では、必要なライブラリのインストールから、MarkdownをHTMLに変換し、さらにHTMLをPDFに変換する手順を詳しく解説します。

これにより、Markdownの利便性を活かしつつ、プロフェッショナルな文書を作成することが可能になります。

必要なライブラリのインストール

MarkdownをPDFに変換するためには、いくつかのライブラリをインストールする必要があります。

以下に、必要なライブラリとそのインストール方法を示します。

markdownライブラリのインストール

MarkdownをHTMLに変換するためのライブラリです。

以下のコマンドを実行してインストールします。

pip install markdown

pdfkitライブラリのインストール

HTMLをPDFに変換するためのライブラリです。

次のコマンドでインストールできます。

pip install pdfkit

weasyprintライブラリのインストール

もう一つのHTMLからPDFへの変換ライブラリです。

以下のコマンドでインストールします。

pip install weasyprint

wkhtmltopdfのインストールと設定

pdfkitを使用するためには、wkhtmltopdfが必要です。

以下の手順でインストールします。

wkhtmltopdfの公式サイトから、OSに合ったインストーラーをダウンロードします。
インストーラーを実行して、指示に従ってインストールします。
インストール後、コマンドラインで以下のコマンドを実行して、正しくインストールされたか確認します。

wkhtmltopdf --version

これで、MarkdownをPDFに変換するための準備が整いました。

次のステップでは、MarkdownをHTMLに変換する方法を解説します。

markdownライブラリでMarkdownをHTMLに変換

MarkdownをHTMLに変換するためには、markdownライブラリを使用します。

このライブラリは、Markdown形式のテキストを簡単にHTMLに変換することができます。

markdownライブラリの基本的な使い方

markdownライブラリを使用するには、まずインポートします。

以下のように、基本的な使い方を示します。

import markdown
# Markdownテキストの例
markdown_text = """
# タイトル
これはMarkdown形式のテキストです。

- リスト項目1
- リスト項目2
"""
# MarkdownをHTMLに変換
html_output = markdown.markdown(markdown_text)
print(html_output)

このコードを実行すると、Markdown形式のテキストがHTMLに変換されます。

MarkdownからHTMLへの変換手順

Markdown形式のテキストを用意します。
markdownライブラリをインポートします。
markdown.markdown()関数を使用して、MarkdownテキストをHTMLに変換します。

以下は、MarkdownからHTMLへの変換のサンプルコードです。

import markdown
# Markdownテキスト
markdown_text = """
# 見出し
これはサンプルのMarkdownテキストです。

- アイテム1
- アイテム2
"""
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# 結果を表示
print(html_output)

出力結果は以下のようになります。

<h1>見出し</h1>
<p>これはサンプルのMarkdownテキストです。</p>
<ul>
<li>アイテム1</li>
<li>アイテム2</li>
</ul>

HTMLファイルの保存方法

変換したHTMLをファイルに保存するには、以下の手順を実行します。

変換したHTMLを文字列として取得します。
open()関数を使用して新しいHTMLファイルを作成します。
write()メソッドでHTMLをファイルに書き込みます。

以下は、HTMLファイルに保存するサンプルコードです。

import markdown
# Markdownテキスト
markdown_text = "# タイトル\nこれはMarkdown形式のテキストです。"
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# HTMLファイルに保存
with open("output.html", "w", encoding="utf-8") as f:
    f.write(html_output)

このコードを実行すると、output.htmlというファイルが作成され、変換されたHTMLが保存されます。

これで、MarkdownをHTMLに変換し、ファイルに保存する準備が整いました。

次のステップでは、HTMLをPDFに変換する方法を解説します。

pdfkitを使ってHTMLをPDFに変換

pdfkitライブラリを使用すると、HTMLを簡単にPDFに変換することができます。

このセクションでは、pdfkitの基本的な使い方や、HTMLからPDFへの変換手順を解説します。

pdfkitの基本的な使い方

pdfkitを使用するには、まずライブラリをインポートし、from_file()やfrom_string()メソッドを使用してHTMLをPDFに変換します。

以下は、基本的な使い方の例です。

import pdfkit
# HTMLコンテンツの例
html_content = """
<html>
<head>
    <title>サンプルPDF</title>
</head>
<body>
    <h1>これはPDFに変換されるHTMLです</h1>
    <p>PDFに変換するためのサンプルです。</p>
</body>
</html>
"""
# PDFに変換
pdfkit.from_string(html_content, 'output.pdf')

このコードを実行すると、output.pdfというファイルが生成されます。

HTMLからPDFへの変換手順

pdfkitライブラリをインポートします。
HTMLコンテンツを用意します(文字列またはファイル)。
pdfkit.from_string()またはpdfkit.from_file()メソッドを使用してPDFに変換します。

以下は、HTMLファイルからPDFに変換するサンプルコードです。

import pdfkit
# HTMLファイルからPDFに変換
pdfkit.from_file('output.html', 'output.pdf')

wkhtmltopdfの設定とパスの確認

pdfkitを使用するためには、wkhtmltopdfが正しくインストールされている必要があります。

以下の手順で設定を確認します。

wkhtmltopdfがインストールされているか確認します。

コマンドラインで以下を実行します。

wkhtmltopdf --version

pdfkitにwkhtmltopdfのパスを指定する場合、以下のように設定します。

import pdfkit
# wkhtmltopdfのパスを指定
config = pdfkit.configuration(wkhtmltopdf='/usr/local/bin/wkhtmltopdf')  # パスは環境に応じて変更
pdfkit.from_file('output.html', 'output.pdf', configuration=config)

PDFの保存とカスタマイズオプション

PDFを保存する際に、さまざまなカスタマイズオプションを指定することができます。

例えば、ページサイズやマージンを設定することが可能です。

以下は、カスタマイズオプションを指定してPDFを生成するサンプルコードです。

import pdfkit
# HTMLコンテンツ
html_content = "<h1>カスタマイズされたPDF</h1><p>これはカスタマイズされたPDFです。</p>"
# オプション設定
options = {
    'page-size': 'A4',
    'margin-top': '10mm',
    'margin-right': '10mm',
    'margin-bottom': '10mm',
    'margin-left': '10mm',
}
# PDFに変換
pdfkit.from_string(html_content, 'custom_output.pdf', options=options)

このコードを実行すると、指定したオプションに基づいてカスタマイズされたPDFが生成されます。

これで、HTMLをPDFに変換する準備が整いました。

次のステップでは、weasyprintを使用したPDF変換方法を解説します。

weasyprintを使ってHTMLをPDFに変換

weasyprintは、HTMLとCSSを使用して高品質なPDFを生成するためのライブラリです。

このセクションでは、weasyprintの基本的な使い方や、HTMLからPDFへの変換手順を解説します。

weasyprintの基本的な使い方

weasyprintを使用するには、まずライブラリをインポートします。

以下は、基本的な使い方の例です。

from weasyprint import HTML
# HTMLコンテンツの例
html_content = """
<html>
<head>
    <title>サンプルPDF</title>
</head>
<body>
    <h1>これはPDFに変換されるHTMLです</h1>
    <p>PDFに変換するためのサンプルです。</p>
</body>
</html>
"""
# PDFに変換
HTML(string=html_content).write_pdf('output.pdf')

このコードを実行すると、output.pdfというファイルが生成されます。

HTMLからPDFへの変換手順

weasyprintライブラリをインポートします。
HTMLコンテンツを用意します(文字列またはファイル)。
HTMLクラスを使用してPDFに変換します。

以下は、HTMLファイルからPDFに変換するサンプルコードです。

from weasyprint import HTML
# HTMLファイルからPDFに変換
HTML('output.html').write_pdf('output.pdf')

CSSを使ったPDFのスタイル調整

weasyprintでは、CSSを使用してPDFのスタイルを調整することができます。

以下は、CSSを使ったスタイル調整の例です。

from weasyprint import HTML, CSS
# HTMLコンテンツ
html_content = """
<html>
<head>
    <title>スタイル調整されたPDF</title>
    <style>
        h1 {
            color: blue;
            text-align: center;
        }
        p {
            font-size: 14px;
            line-height: 1.5;
        }
    </style>
</head>
<body>
    <h1>カスタマイズされたPDF</h1>
    <p>これはスタイル調整されたPDFです。</p>
</body>
</html>
"""
# PDFに変換
HTML(string=html_content).write_pdf('styled_output.pdf')

このコードを実行すると、指定したCSSスタイルが適用されたPDFが生成されます。

PDFの保存とカスタマイズオプション

weasyprintでは、PDFを保存する際にさまざまなカスタマイズオプションを指定することができます。

例えば、ページサイズやマージンを設定することが可能です。

以下は、カスタマイズオプションを指定してPDFを生成するサンプルコードです。

from weasyprint import HTML, CSS
# HTMLコンテンツ
html_content = "<h1>カスタマイズされたPDF</h1><p>これはカスタマイズされたPDFです。</p>"
# CSSオプション
css = CSS(string='''
@page {
    size: A4;
    margin: 10mm;
}
h1 {
    color: green;
}
''')
# PDFに変換
HTML(string=html_content).write_pdf('custom_styled_output.pdf', stylesheets=[css])

このコードを実行すると、指定したオプションに基づいてカスタマイズされたPDFが生成されます。

これで、weasyprintを使用してHTMLをPDFに変換する準備が整いました。

次のステップでは、応用例を紹介します。

応用例

MarkdownをPDFに変換する方法は多岐にわたります。

ここでは、いくつかの応用例を紹介します。

複数のMarkdownファイルを一つのPDFにまとめる方法

複数のMarkdownファイルを一つのPDFにまとめるには、まず各MarkdownファイルをHTMLに変換し、それらを結合してからPDFに変換します。

以下はその手順の例です。

import markdown
import pdfkit
# Markdownファイルのリスト
markdown_files = ['file1.md', 'file2.md', 'file3.md']
html_content = ""
# 各MarkdownファイルをHTMLに変換
for file in markdown_files:
    with open(file, 'r', encoding='utf-8') as f:
        markdown_text = f.read()
        html_content += markdown.markdown(markdown_text) + "<hr>"
# HTMLをPDFに変換
pdfkit.from_string(html_content, 'combined_output.pdf')

画像やリンクを含むMarkdownをPDFに変換する方法

Markdownに画像やリンクを含めることも可能です。

以下は、画像とリンクを含むMarkdownをPDFに変換する例です。

import markdown
import pdfkit
# Markdownテキスト
markdown_text = """
# サンプルPDF
![画像の説明](https://example.com/image.png)
[リンクテキスト](https://example.com)
"""
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# PDFに変換
pdfkit.from_string(html_output, 'output_with_image_and_link.pdf')

PDFのメタデータ(タイトル、著者など)を設定する方法

PDFのメタデータを設定するには、pdfkitのオプションを使用します。

以下は、メタデータを設定する例です。

import pdfkit
# HTMLコンテンツ
html_content = "<h1>メタデータ付きPDF</h1><p>これはメタデータが設定されたPDFです。</p>"
# オプション設定
options = {
    'title': 'サンプルPDF',
    'author': '著者名',
}
# PDFに変換
pdfkit.from_string(html_content, 'output_with_metadata.pdf', options=options)

コマンドラインからMarkdownをPDFに変換するスクリプトの作成

コマンドラインからMarkdownをPDFに変換するスクリプトを作成することもできます。

以下はその例です。

import sys
import markdown
import pdfkit
# コマンドライン引数からMarkdownファイルを取得
markdown_file = sys.argv[1]
# Markdownファイルを読み込み
with open(markdown_file, 'r', encoding='utf-8') as f:
    markdown_text = f.read()
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# PDFに変換
pdfkit.from_string(html_output, 'output.pdf')

このスクリプトをconvert.pyとして保存し、コマンドラインから以下のように実行します。

python convert.py input.md

FlaskやDjangoでMarkdownをPDFに変換するWebアプリケーションの作成

FlaskやDjangoを使用して、MarkdownをPDFに変換するWebアプリケーションを作成することも可能です。

以下はFlaskの簡単な例です。

from flask import Flask, request, send_file
import markdown
import pdfkit
app = Flask(__name__)
@app.route('/convert', methods=['POST'])
def convert():
    markdown_text = request.form['markdown']
    html_output = markdown.markdown(markdown_text)
    pdfkit.from_string(html_output, 'output.pdf')
    return send_file('output.pdf')
if __name__ == '__main__':
    app.run(debug=True)