PythonでHTMLをMarkdownに変換する：包括的なガイド

pip install html2text

import html2text

# コンバータインスタンスの作成
h = html2text.HTML2Text()

# オプションの設定
h.ignore_links = False
h.ignore_images = False
h.ignore_emphasis = False
h.body_width = 0  # 行を折り返さない

html_content = """
<h1>ウェブスクレイピングへようこそ</h1>
<p>これは <strong>包括的なガイド</strong> です。</p>
<ul>
    <li>使いやすい</li>
    <li>実績あり</li>
    <li>広く採用されている</li>
</ul>
<a href="https://example.com">もっと見る</a>
"""

markdown = h.handle(html_content)
print(markdown)

# ウェブスクレイピングへようこそ

これは **包括的なガイド** です。

  * 使いやすい
  * 実績あり
  * 広く採用されている

[もっと見る](https://example.com)

import html2text

h = html2text.HTML2Text()

# 特定の要素をスキップ
h.ignore_links = True
h.ignore_images = True

# フォーマットの制御
h.body_width = 80  # 80文字で折り返す
h.unicode_snob = True  # Unicode文字を使用
h.emphasis_mark = '*'  # 強調に*を使用
h.strong_mark = '**'

# テーブルの処理
h.ignore_tables = False

# プレフォーマットテキストの保護
h.protect_links = True

pip install markdownify

from markdownify import markdownify as md

html = """
<article>
    <h2>現代のウェブ開発</h2>
    <p>Pythonと<code>現代のフレームワーク</code>を使用して構築。</p>
    <blockquote>
        <p>シンプルさは究極の洗練です。</p>
    </blockquote>
</article>
"""

markdown = md(html)
print(markdown)

## 現代のウェブ開発

Pythonと`現代のフレームワーク`を使用して構築。

> シンプルさは究極の洗練です。

from markdownify import MarkdownConverter

class CustomConverter(MarkdownConverter):
    """
    特定のタグ処理を持つカスタムコンバータの作成
    """
    def convert_img(self, el, text, convert_as_inline):
        """カスタム画像ハンドラ（代替テキスト付き）"""
        alt = el.get('alt', '')
        src = el.get('src', '')
        title = el.get('title', '')

        if title:
            return f'![{alt}]({src} "{title}")'
        return f'![{alt}]({src})'

    def convert_pre(self, el, text, convert_as_inline):
        """コードブロックの処理を強化し、言語検出を実装"""
        code = el.find('code')
        if code:
            # クラス属性から言語を抽出（例: 'language-python'）
            classes = code.get('class', [''])
            language = classes[0].replace('language-', '') if classes else ''
            return f'\n```{language}\n{code.get_text()}\n```\n'
        return f'\n```\n{text}\n```\n'

# カスタムコンバータの使用
html = '<pre><code class="language-python">def hello():\n    print("world")</code></pre>'
markdown = CustomConverter().convert(html)
print(markdown)

from markdownify import markdownify as md

# 特定のタグを完全に削除
markdown = md(html, strip=['script', 'style', 'nav'])

# 特定のタグのみ変換
markdown = md(
    html,
    heading_style="ATX",  # ヘッディングに#を使用
    bullets="-",  # リストに-を使用
    strong_em_symbol="*",  # 強調に*を使用
)

pip install html-to-markdown

from html_to_markdown import convert

html = """
<article>
    <h1>技術ドキュメンテーション</h1>
    <table>
        <thead>
            <tr>
                <th>機能</th>
                <th>サポート</th>
            </tr>
        </thead>
        <tbody>
            <tr>
                <td>HTML5</td>
                <td>✓</td>
            </tr>
            <tr>
                <td>テーブル</td>
                <td>✓</td>
            </tr>
        </tbody>
    </table>
</article>
"""

markdown = convert(html)
print(markdown)

from html_to_markdown import convert, Options

# カスタムオプションの作成
options = Options(
    heading_style="ATX",
    bullet_style="-",
    code_language_default="python",
    strip_tags=["script", "style"],
    escape_special_chars=True,
    table_style="pipe",  # テーブルに|を使用
    preserve_whitespace=False,
    extract_metadata=True,  # メタタグの抽出
)

markdown = convert(html, options=options)

# 単一ファイルの変換
html-to-markdown input.html -o output.md

# オプション付きの変換
html-to-markdown input.html \
    --heading-style atx \
    --strip-tags script,style \
    --extract-metadata

# バッチ変換
find ./html_files -name "*.html" -exec html-to-markdown {} -o ./markdown_files/{}.md \;

pip install trafilatura

import trafilatura

# URLからダウンロードして抽出
url = "https://example.com/article"
downloaded = trafilatura.fetch_url(url)
markdown = trafilatura.extract(downloaded, output_format='markdown')
print(markdown)

import trafilatura
from trafilatura.settings import use_config

# カスタム設定の作成
config = use_config()
config.set("DEFAULT", "EXTRACTION_TIMEOUT", "30")

html = """
<html>
<head><title>記事タイトル</title></head>
<body>
    <nav>ナビゲーションメニュー</nav>
    <article>
        <h1>主な記事</h1>
        <p>重要なコンテンツがここにあります。</p>
    </article>
    <aside>広告</aside>
    <footer>フッターコンテンツ</footer>
</body>
</html>
"""

# 本体コンテンツのみ抽出
markdown = trafilatura.extract(
    html,
    output_format='markdown',
    include_comments=False,
    include_tables=True,
    include_images=True,
    include_links=True,
    config=config
)

# メタデータ付きで抽出
result = trafilatura.extract(
    html,
    output_format='markdown',
    with_metadata=True
)

if result:
    print(f"タイトル: {result.get('title', 'N/A')}")
    print(f"著者: {result.get('author', 'N/A')}")
    print(f"日付: {result.get('date', 'N/A')}")
    print(f"\nコンテンツ:\n{result.get('text', '')}")

import trafilatura
from concurrent.futures import ThreadPoolExecutor
from pathlib import Path

def process_url(url):
    """URLからMarkdownを抽出"""
    downloaded = trafilatura.fetch_url(url)
    if downloaded:
        return trafilatura.extract(
            downloaded,
            output_format='markdown',
            include_links=True,
            include_images=True
        )
    return None

# 複数のURLを並列処理
urls = [
    "https://example.com/article1",
    "https://example.com/article2",
    "https://example.com/article3",
]

with ThreadPoolExecutor(max_workers=5) as executor:
    results = list(executor.map(process_url, urls))

for i, markdown in enumerate(results):
    if markdown:
        Path(f"article_{i}.md").write_text(markdown, encoding='utf-8')

pip install domscribe

from domscribe import html_to_markdown

html = """
<article>
    <header>
        <h1>セマンティックHTMLの理解</h1>
        <time datetime="2024-10-24">2024年10月24日</time>
    </header>
    <section>
        <h2>導入</h2>
        <p>セマンティックHTMLは<mark>意味</mark>をコンテンツに提供します。</p>
    </section>
    <aside>
        <h3>関連トピック</h3>
        <ul>
            <li>アクセシビリティ</li>
            <li>SEO</li>
        </ul>
    </aside>
</article>
"""

markdown = html_to_markdown(html)
print(markdown)

from domscribe import html_to_markdown, MarkdownOptions

options = MarkdownOptions(
    preserve_semantic_structure=True,
    include_aria_labels=True,
    strip_empty_elements=True
)

markdown = html_to_markdown(html, options=options)

pip install html2md

# 全ディレクトリの変換
m1f-html2md convert ./website -o ./docs

# カスタム設定付き
m1f-html2md convert ./website -o ./docs \
    --remove-tags nav,footer \
    --heading-offset 1 \
    --detect-language

# 単一ファイルの変換
m1f-html2md convert index.html -o readme.md

import asyncio
from html2md import convert_html

async def convert_files():
    """非同期バッチ変換"""
    html_files = [
        'page1.html',
        'page2.html',
        'page3.html'
    ]

    tasks = [convert_html(file) for file in html_files]
    results = await asyncio.gather(*tasks)
    return results

# 変換の実行
results = asyncio.run(convert_files())

import time
import html2text
from markdownify import markdownify
from html_to_markdown import convert
import trafilatura

def benchmark(html_content, iterations=100):
    """変換速度のベンチマーク"""

    # html2text
    start = time.time()
    h = html2text.HTML2Text()
    for _ in range(iterations):
        _ = h.handle(html_content)
    html2text_time = time.time() - start

    # markdownify
    start = time.time()
    for _ in range(iterations):
        _ = markdownify(html_content)
    markdownify_time = time.time() - start

    # html-to-markdown
    start = time.time()
    for _ in range(iterations):
        _ = convert(html_content)
    html_to_markdown_time = time.time() - start

    # trafilatura
    start = time.time()
    for _ in range(iterations):
        _ = trafilatura.extract(html_content, output_format='markdown')
    trafilatura_time = time.time() - start

    return {
        'html2text': html2text_time,
        'markdownify': markdownify_time,
        'html-to-markdown': html_to_markdown_time,
        'trafilatura': trafilatura_time
    }

import trafilatura
from pathlib import Path
from concurrent.futures import ProcessPoolExecutor

def process_html_file(html_path):
    """HTMLファイルをマークダウンに変換"""
    html = Path(html_path).read_text(encoding='utf-8')
    markdown = trafilatura.extract(
        html,
        output_format='markdown',
        include_links=False,  # よりクリーンなトレーニングデータのために削除
        include_images=False,
        include_comments=False
    )

    if markdown:
        output_path = html_path.replace('.html', '.md')
        Path(output_path).write_text(markdown, encoding='utf-8')
        return len(markdown)
    return 0

# 10,000ファイルを並列処理
html_files = list(Path('./docs').rglob('*.html'))

with ProcessPoolExecutor(max_workers=8) as executor:
    token_counts = list(executor.map(process_html_file, html_files))

print(f"{len(html_files)}ファイルを処理しました")
print(f"合計文字数: {sum(token_counts):,}")

# フロントマター付きですべての投稿を変換
m1f-html2md convert ./wordpress-export \
    -o ./hugo/content/posts \
    --generate-frontmatter \
    --heading-offset 0 \
    --remove-tags script,style,nav,footer

from html_to_markdown import convert, Options
from pathlib import Path
import yaml

def migrate_post(html_file):
    """WordPress HTMLをHugoマークダウンに変換"""
    html = Path(html_file).read_text()

    # HTMLからタイトルと日付を抽出
    from bs4 import BeautifulSoup
    soup = BeautifulSoup(html, 'html.parser')
    title = soup.find('h1').get_text() if soup.find('h1') else 'Untitled'

    # マークダウンに変換
    options = Options(strip_tags=['script', 'style', 'nav', 'footer'])
    markdown = convert(html, options=options)

    # Hugoフロントマターを追加
    frontmatter = {
        'title': title,
        'date': '2024-10-24',
        'draft': False,
        'tags': []
    }

    output = f"---\n{yaml.dump(frontmatter)}---\n\n{markdown}"

    # 保存
    output_file = html_file.replace('.html', '.md')
    Path(output_file).write_text(output, encoding='utf-8')

# すべての投稿を処理
for html_file in Path('./wordpress-export').glob('*.html'):
    migrate_post(html_file)

from markdownify import MarkdownConverter
import requests

class DocsConverter(MarkdownConverter):
    """技術ドキュメンテーション用のカスタムコンバーター"""

    def convert_pre(self, el, text, convert_as_inline):
        """シンタックスハイライト付きのコードブロック"""
        code = el.find('code')
        if code:
            # クラスから言語を抽出
            classes = code.get('class', [])
            language = next(
                (c.replace('language-', '') for c in classes if c.startswith('language-')),
                'text'
            )
            return f'\n```{language}\n{code.get_text()}\n```\n'
        return super().convert_pre(el, text, convert_as_inline)

    def convert_div(self, el, text, convert_as_inline):
        """特殊なドキュメンテーションブロックの処理"""
        classes = el.get('class', [])

        # 警告ブロック
        if 'warning' in classes:
            return f'\n> ⚠️ **Warning**: {text}\n'

        # 情報ブロック
        if 'info' in classes or 'note' in classes:
            return f'\n> 💡 **Note**: {text}\n'

        return text

def scrape_docs(url):
    """ドキュメンテーションページをスクレイプして変換"""
    response = requests.get(url)
    markdown = DocsConverter().convert(response.text)
    return markdown

# 使用
docs_url = "https://docs.example.com/api-reference"
markdown = scrape_docs(docs_url)
Path('api-reference.md').write_text(markdown)

import html2text
import email
from pathlib import Path

def convert_newsletter(email_file):
    """HTMLメールをマークダウンに変換"""
    # メールを解析
    with open(email_file, 'r') as f:
        msg = email.message_from_file(f)

    # HTML部分を取得
    html_content = None
    for part in msg.walk():
        if part.get_content_type() == 'text/html':
            html_content = part.get_payload(decode=True).decode('utf-8')
            break

    if not html_content:
        return None

    # コンバーターを設定
    h = html2text.HTML2Text()
    h.ignore_images = False
    h.images_to_alt = True
    h.body_width = 0
    h.protect_links = True
    h.unicode_snob = True

    # 変換
    markdown = h.handle(html_content)

    # メタデータを追加
    subject = msg.get('Subject', 'No Subject')
    date = msg.get('Date', '')

    output = f"# {subject}\n\n*Date: {date}*\n\n---\n\n{markdown}"

    return output

# ニュースレターのアーカイブを処理
for email_file in Path('./newsletters').glob('*.eml'):
    markdown = convert_newsletter(email_file)
    if markdown:
        output_file = email_file.with_suffix('.md')
        output_file.write_text(markdown, encoding='utf-8')

from bs4 import BeautifulSoup
import trafilatura

def clean_and_convert(html):
    """変換前に不要な要素を削除"""
    soup = BeautifulSoup(html, 'html.parser')

    # 不要な要素を削除
    for element in soup(['script', 'style', 'nav', 'footer', 'header', 'aside']):
        element.decompose()

    # 広告とトラッキングを削除
    for element in soup.find_all(class_=['ad', 'advertisement', 'tracking']):
        element.decompose()

    # クリーンなHTMLを変換
    markdown = trafilatura.extract(
        str(soup),
        output_format='markdown'
    )

    return markdown

import re

def normalize_markdown(markdown):
    """マークダウンのホワイトスペースを整える"""
    # 複数の空白行を削除
    markdown = re.sub(r'\n{3,}', '\n\n', markdown)

    # 末尾のホワイトスペースを削除
    markdown = '\n'.join(line.rstrip() for line in markdown.split('\n'))

    # 終端に1つの改行を保証
    markdown = markdown.rstrip() + '\n'

    return markdown

def validate_markdown(markdown):
    """マークダウンの品質を検証"""
    issues = []

    # HTMLの残りをチェック
    if '<' in markdown and '>' in markdown:
        issues.append("HTMLタグが検出されました")

    # 破損したリンクをチェック
    if '[' in markdown and ']()' in markdown:
        issues.append("空のリンクが検出されました")

    # 過剰なコードブロックをチェック
    code_block_count = markdown.count('```')
    if code_block_count % 2 != 0:
        issues.append("閉じられていないコードブロック")

    return len(issues) == 0, issues

from pathlib import Path
from concurrent.futures import ProcessPoolExecutor
import trafilatura
import logging

logging.basicConfig(level=logging.INFO)
logger = logging.getLogger(__name__)

def process_file(html_path):
    """単一のHTMLファイルを処理"""
    try:
        html = Path(html_path).read_text(encoding='utf-8')
        markdown = trafilatura.extract(
            html,
            output_format='markdown',
            include_links=True,
            include_images=False
        )

        if markdown:
            # 正規化
            markdown = normalize_markdown(markdown)

            # 検証
            is_valid, issues = validate_markdown(markdown)
            if not is_valid:
                logger.warning(f"{html_path}: {', '.join(issues)}")

            # 保存
            output_path = Path(str(html_path).replace('.html', '.md'))
            output_path.write_text(markdown, encoding='utf-8')

            return True

        return False

    except Exception as e:
        logger.error(f"{html_path}の処理中にエラーが発生しました: {e}")
        return False

def batch_convert(input_dir, max_workers=4):
    """ディレクトリ内のすべてのHTMLファイルを変換"""
    html_files = list(Path(input_dir).rglob('*.html'))
    logger.info(f"{len(html_files)}個のHTMLファイルが見つかりました")

    with ProcessPoolExecutor(max_workers=max_workers) as executor:
        results = list(executor.map(process_file, html_files))

    success_count = sum(results)
    logger.info(f"{success_count}/{len(html_files)}ファイルが成功裏に変換されました")

# 使用
batch_convert('./html_docs', max_workers=8)