Python Markdown で HTML を生成

Markdown は軽量なマークアップ言語で、読み書きしやすいプレーンテキスト形式でドキュメントを作成し、それを構造化された HTML ドキュメントに変換することができます。

Markdown の構文はシンプルで直感的であり、ブログやドキュメント、README ファイルなどの作成によく使用されます。

Markdown の詳細については、以下を参照してください:Markdown チュートリアル

Python は markdown モジュールを使用して、Markdown テキストを HTML に変換できます。


Markdown を HTML に変換する手順

1. インストールmarkdown 库

まず、Python のmarkdownライブラリをインストールする必要があります。それにはpipを使用できます:

pip install markdown

2. Python スクリプトを書く

以下は、Markdown テキストを HTML に変換する簡単な例です:

実例

import markdown

# Markdown テキストを定義
md_text = """
# これは見出しです
これは **太字** のテキストです。
これは *斜体* のテキストです。

- リスト項目 1
- リスト項目 2

[ここをクリック](https://www.example.com) してウェブサイトにアクセスしてください。
"""


# HTML に変換
html_output = markdown.markdown(md_text)

# HTML を出力
print(html_output)

出力結果は次のとおりです:

<h1>这是标题</h1>
<p>这是 <strong>加粗</strong> 的文本。  
这是 <em>斜体</em> 的文本。</p>
<ul>
<li>列表项 1</li>
<li>列表项 2</li>
</ul>
<p><a href="../index.html">点击这里</a> 访问网站。</p>

次に、簡単な Python スクリプトを作成して、Markdown ファイル(上記の例の Markdown テキストをファイルに保存できます)を HTML ファイルに変換できます:

convert_markdown_to_html.py ファイルのコード:

import markdown

# Markdown ファイルを読み取る
with open('example.md', 'r', encoding='utf-8') as file:
    markdown_text = file.read()

# Markdown を HTML に変換
html = markdown.markdown(markdown_text)

# HTML をファイルに書き込む
with open('example.html', 'w', encoding='utf-8') as file:
    file.write(html)

print("Markdown ファイルは HTML ファイルに正常に変換されました!")

3. スクリプトを実行する

上記のコードをconvert_markdown_to_html.pyとして保存し、ターミナルで実行します:

python convert_markdown_to_html.py

実行後、example.mdファイルはexample.htmlファイルに変換されます。

コードの説明:

import markdown:このコード行はmarkdownライブラリをインポートします。このライブラリは Markdown テキストを HTML に変換する機能を提供します。

with open('example.md', 'r', encoding='utf-8') as file:
    markdown_text = file.read()

このコードはopen関数を使ってexample.mdファイルを開き、その内容をmarkdown_text変数に読み込みます。

html = markdown.markdown(markdown_text):このコード行はmarkdown.markdown()関数で Markdown テキストを HTML テキストに変換します。

with open('example.html', 'w', encoding='utf-8') as file:
    file.write(html)

このコードは、変換された HTML テキストをexample.htmlファイルに書き込みます。


拡張機能

markdownライブラリは、テーブルやコードハイライトなどのさまざまな拡張機能をサポートしています。次のようにして拡張機能を有効にできます:

html = markdown.markdown(markdown_text, extensions=['tables', 'fenced_code'])

必要に応じて、HTML 出力のスタイルと構造をカスタマイズできます。

Python を使用して Markdown を HTML に変換することは、シンプルで強力なツールであり、ドキュメント生成プロセスを自動化するのに役立ちます。ブログ、ドキュメント、プロジェクトの説明のいずれを執筆する場合でも、この方法は作業効率を大幅に向上させることができます。この記事が、Python での Markdown 変換機能をすぐに使いこなす助けになることを願っています!


参考リソース

その他の拡張機能