ドキュメント

[Python] markdownをHTMLに変換する方法

2025-04-15更新日: 2025-04-15

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

このライブラリは、Markdown形式のテキストをHTMLに変換するためのシンプルな方法を提供します。

まず、pip install markdownでライブラリをインストールし、次にmarkdown.markdown()関数を使ってMarkdownテキストをHTMLに変換します。

例えば、html = markdown.markdown(markdown_text)のように記述します。

目次から探す

Markdownとは何か
PythonでMarkdownをHTMLに変換する方法
markdownライブラリのオプション設定
応用例：MarkdownからHTMLへの変換を自動化する
他のライブラリとの比較
まとめ

Markdownとは何か

Markdownは、テキストを簡潔に書くための軽量マークアップ言語です。

主に文書のフォーマットを整えるために使用され、HTMLに変換することが容易です。

Markdownの特徴は、シンプルな記法でありながら、見出し、リスト、リンク、画像などの要素を簡単に表現できる点です。

これにより、プログラマーやライターは、複雑なHTMLコードを書くことなく、視覚的に整った文書を作成できます。

特に、GitHubやブログプラットフォームなどで広く利用されており、コンテンツの作成や管理を効率化するためのツールとして重宝されています。

PythonでMarkdownをHTMLに変換する方法

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

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

このライブラリは、簡単にMarkdown形式のテキストをHTMLに変換する機能を提供します。

以下のコマンドを使用して、markdownライブラリをインストールします。

pip install markdown

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

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

次に、Markdown形式のテキストをHTMLに変換するための基本的なコードを示します。

import markdown
# Markdown形式のテキスト
markdown_text = """
# 見出し1
これはMarkdownのサンプルです。
- リスト項目1
- リスト項目2
"""
# HTMLに変換
html_output = markdown.markdown(markdown_text)
print(html_output)

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

markdown.markdown()関数の使い方

markdown.markdown()関数は、MarkdownテキストをHTMLに変換するための主要な関数です。

この関数は、Markdown形式の文字列を引数として受け取り、対応するHTMLを返します。

以下はその使用例です。

import markdown
# Markdown形式のテキスト
markdown_text = "# 見出し\nこれはサンプルテキストです。"
# HTMLに変換
html_output = markdown.markdown(markdown_text)
print(html_output)

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

<h1>見出し</h1>
<p>これはサンプルテキストです。</p>

変換結果のHTMLの確認方法

MarkdownをHTMLに変換した後、その結果を確認する方法はいくつかあります。

最も簡単な方法は、コンソールに出力することです。

上記のコード例では、print(html_output)を使用してHTMLを表示しています。

また、変換したHTMLをファイルに保存することも可能です。

以下のコードは、変換結果をoutput.htmlというファイルに書き込む例です。

import markdown
# Markdown形式のテキスト
markdown_text = "# 見出し\nこれはサンプルテキストです。"
# 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ライブラリのオプション設定

拡張機能の利用方法

markdownライブラリは、基本的なMarkdownの機能に加えて、さまざまな拡張機能を提供しています。

これにより、より高度なMarkdownの記法を使用することができます。

拡張機能を利用するには、markdown.markdown()関数のextensions引数に拡張機能を指定します。

以下は、tables拡張機能を使用する例です。

import markdown
# Markdown形式のテキスト
markdown_text = """
| 見出し1 | 見出し2 |
|---------|---------|
| データ1 | データ2 |
"""
# HTMLに変換(拡張機能を指定)
html_output = markdown.markdown(markdown_text, extensions=['tables'])
print(html_output)

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

<table>
<thead>
<tr><th>見出し1</th><th>見出し2</th></tr>
</thead>
<tbody>
<tr><td>データ1</td><td>データ2</td></tr>
</tbody>
</table>

カスタムCSSの適用

変換したHTMLにカスタムCSSを適用することで、スタイルを変更することができます。

HTMLに<link>タグを追加して、外部CSSファイルを読み込むことが一般的です。

以下は、カスタムCSSを適用する例です。

import markdown
# Markdown形式のテキスト
markdown_text = "# 見出し\nこれはサンプルテキストです。"
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# カスタムCSSを適用
html_with_css = f"""
<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <link rel="stylesheet" href="style.css">
    <title>Markdown to HTML</title>
</head>
<body>
{html_output}
</body>
</html>
"""
# HTMLをファイルに保存
with open("output_with_css.html", "w", encoding="utf-8") as f:
    f.write(html_with_css)

特定のHTMLタグを無効化する方法

MarkdownをHTMLに変換する際に、特定のHTMLタグを無効化したい場合は、safe_modeオプションを使用します。

このオプションをTrueに設定すると、危険なHTMLタグが無効化されます。

以下はその例です。

import markdown
# Markdown形式のテキスト
markdown_text = "<script>alert('危険なスクリプト');</script>\n# 見出し"
# HTMLに変換(安全モードを有効化)
html_output = markdown.markdown(markdown_text, safe_mode=True)
print(html_output)

この場合、<script>タグは無効化され、出力結果には表示されません。

セキュリティ対策としてのサニタイズ処理

MarkdownをHTMLに変換する際には、セキュリティ対策としてサニタイズ処理を行うことが重要です。

サニタイズ処理とは、ユーザーからの入力を安全な形式に変換することを指します。

markdownライブラリには、bleachライブラリを併用することで、HTMLをサニタイズする方法があります。

以下はその例です。

import markdown
import bleach
# Markdown形式のテキスト
markdown_text = "<script>alert('危険なスクリプト');</script>\n# 見出し"
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# サニタイズ処理
allowed_tags = ['h1', 'p', 'ul', 'li']  # 許可するタグ
sanitized_html = bleach.clean(html_output, tags=allowed_tags)
print(sanitized_html)

このコードでは、allowed_tagsに指定したタグのみが残り、他のタグは削除されます。

これにより、セキュリティリスクを軽減することができます。

応用例：MarkdownからHTMLへの変換を自動化する

ファイルの読み込みと書き込み

Markdownファイルを読み込み、HTMLに変換して新しいファイルに書き込む方法を示します。

以下のコードでは、input.mdというMarkdownファイルを読み込み、変換結果をoutput.htmlというファイルに保存します。

import markdown
# Markdownファイルの読み込み
with open("input.md", "r", encoding="utf-8") as md_file:
    markdown_text = md_file.read()
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# HTMLをファイルに書き込み
with open("output.html", "w", encoding="utf-8") as html_file:
    html_file.write(html_output)

このコードを実行すると、input.mdの内容がHTMLに変換され、output.htmlに保存されます。

複数のMarkdownファイルを一括変換する方法

複数のMarkdownファイルを一括で変換するには、osモジュールを使用してディレクトリ内のファイルをループ処理します。

以下は、指定したディレクトリ内のすべてのMarkdownファイルをHTMLに変換する例です。

import os
import markdown
# Markdownファイルが格納されているディレクトリ
input_dir = "markdown_files"
output_dir = "html_files"
# 出力ディレクトリが存在しない場合は作成
os.makedirs(output_dir, exist_ok=True)
# ディレクトリ内のMarkdownファイルを一括変換
for filename in os.listdir(input_dir):
    if filename.endswith(".md"):
        with open(os.path.join(input_dir, filename), "r", encoding="utf-8") as md_file:
            markdown_text = md_file.read()
        
        # HTMLに変換
        html_output = markdown.markdown(markdown_text)
        
        # HTMLファイルに書き込み
        output_filename = filename.replace(".md", ".html")
        with open(os.path.join(output_dir, output_filename), "w", encoding="utf-8") as html_file:
            html_file.write(html_output)

このコードを実行すると、markdown_filesディレクトリ内のすべてのMarkdownファイルがhtml_filesディレクトリにHTMLファイルとして保存されます。

コマンドラインツールとしての実装

MarkdownからHTMLへの変換をコマンドラインツールとして実装することも可能です。

以下のコードは、コマンドライン引数で指定されたMarkdownファイルをHTMLに変換する例です。

import sys
import markdown
# コマンドライン引数からファイル名を取得
if len(sys.argv) != 2:
    print("使用法: python convert.py <markdown_file.md>")
    sys.exit(1)
input_file = sys.argv[1]
# Markdownファイルの読み込み
with open(input_file, "r", encoding="utf-8") as md_file:
    markdown_text = md_file.read()
# HTMLに変換
html_output = markdown.markdown(markdown_text)
# HTMLファイル名を生成
output_file = input_file.replace(".md", ".html")
# HTMLをファイルに書き込み
with open(output_file, "w", encoding="utf-8") as html_file:
    html_file.write(html_output)
print(f"{input_file} を {output_file} に変換しました。")

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

python convert.py input.md

Webアプリケーションでの利用

MarkdownからHTMLへの変換をWebアプリケーションで利用する場合、FlaskなどのWebフレームワークを使用することが一般的です。

以下は、Flaskを使用してMarkdownをHTMLに変換する簡単なWebアプリケーションの例です。

from flask import Flask, request, render_template_string
import markdown
app = Flask(__name__)
@app.route("/", methods=["GET", "POST"])
def index():
    html_output = ""
    if request.method == "POST":
        markdown_text = request.form["markdown"]
        html_output = markdown.markdown(markdown_text)
    
    return render_template_string("""
        <form method="post">
            <textarea name="markdown" rows="10" cols="30"></textarea><br>
            <input type="submit" value="変換">
        </form>
        <h2>変換結果:</h2>
        <div>{}</div>
    """.format(html_output))
if __name__ == "__main__":
    app.run(debug=True)

このアプリケーションを実行すると、ブラウザでMarkdownを入力し、HTMLに変換することができます。

http://127.0.0.1:5000/にアクセスして、Markdownを入力してみてください。

他のライブラリとの比較

mistuneライブラリの特徴と使い方

mistuneは、高速で軽量なMarkdownパーサーです。

特にパフォーマンスに優れており、大量のMarkdownテキストを処理する際に効果的です。

mistuneは、拡張機能をサポートしており、カスタマイズが可能です。

以下は、mistuneを使用してMarkdownをHTMLに変換する基本的な例です。

import mistune
# Markdown形式のテキスト
markdown_text = "# 見出し\nこれはMistuneのサンプルです。"
# Markdownパーサーの作成
markdown_parser = mistune.create_markdown()
# HTMLに変換
html_output = markdown_parser(markdown_text)
print(html_output)

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

<h1>見出し</h1>
<p>これはMistuneのサンプルです。</p>

markdown2ライブラリの特徴と使い方

markdown2は、PythonのMarkdownライブラリの中でも特に多機能で、拡張機能が豊富です。

特に、markdown2は、HTMLのサニタイズ機能や、Markdownの拡張機能を簡単に利用できる点が特徴です。

以下は、markdown2を使用してMarkdownをHTMLに変換する例です。

import markdown2
# Markdown形式のテキスト
markdown_text = "# 見出し\nこれはMarkdown2のサンプルです。"
# HTMLに変換
html_output = markdown2.markdown(markdown_text)
print(html_output)

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

<h1>見出し</h1>
<p>これはMarkdown2のサンプルです。</p>

Python-Markdownと他のライブラリの違い

Python-Markdownは、最も広く使用されているMarkdownライブラリの一つで、標準的なMarkdownの仕様に準拠しています。

以下に、Python-Markdownと他のライブラリとの主な違いを示します。

特徴	Python-Markdown	mistune	markdown2
パフォーマンス	中程度	高速	中程度
拡張機能のサポート	あり	あり	あり
HTMLサニタイズ機能	なし	なし	あり
カスタマイズの容易さ	中程度	高い	高い
ドキュメントの充実度	充実	充実	充実