Текст и документы

Собрать HTML из Markdown

Преобразует Markdown в готовую HTML-страницу с оглавлением и аккуратным шаблоном.

Python Windows macOS Linux Средний
Скачать markdown_to_html.py
Описание

Что делает скрипт

Скрипт использует библиотеку markdown с расширениями extra и toc, поэтому таблицы и блоки кода обрабатываются корректно. Заголовок страницы можно задать вручную или взять из имени файла. Результат пишется в отдельную папку, существующие файлы требуют флага --force.

Запуск

Быстрый старт

python markdown_to_html.py --path article.md --output-dir site

Скачайте файл, откройте терминал в папке со скриптом и выполните команду. В Linux и macOS интерпретатор может называться python3, в Windows - python или py.

Примеры

Другие варианты

  • python markdown_to_html.py --path article.md --title 'Заметки'
  • python markdown_to_html.py --path ./docs --glob '*.md' --output-dir site
  • python markdown_to_html.py --path readme.md --css style.css --force
Зависимости

Что понадобится

Python 3.10+ Только стандартная библиотека
Windows winget install Python.Python.3.12
macOS brew install python
Linux sudo apt install python3
Markdown Преобразование Markdown
Windows py -m pip install markdown
macOS python3 -m pip install markdown
Linux python3 -m pip install markdown
Исходник

markdown_to_html.py

#!/usr/bin/env python3
"""Преобразование Markdown в HTML-страницу."""
from __future__ import annotations

import argparse
import html
from pathlib import Path

import markdown

TEMPLATE = """<!doctype html>
<html lang="ru">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<title>{title}</title>
{css}
</head>
<body>
<main>
{body}
</main>
</body>
</html>
"""


def render(source: Path, title: str | None, css: str | None) -> str:
    text = source.read_text(encoding="utf-8")
    body = markdown.markdown(text, extensions=["extra", "sane_lists", "toc"])
    page_title = title or source.stem.replace("-", " ").replace("_", " ")
    style = f'<link rel="stylesheet" href="{html.escape(css, quote=True)}">' if css else ""
    return TEMPLATE.format(title=html.escape(page_title), css=style, body=body)


def main() -> int:
    parser = argparse.ArgumentParser(description="Собрать HTML из Markdown")
    parser.add_argument("--path", type=Path, required=True, help="Файл или папка")
    parser.add_argument("--glob", default="*.md", help="Маска файлов")
    parser.add_argument("--output-dir", type=Path, default=Path("html-out"), help="Папка для HTML")
    parser.add_argument("--title", help="Заголовок страницы для одного файла")
    parser.add_argument("--css", help="Путь к внешнему CSS")
    parser.add_argument("--force", action="store_true", help="Перезаписать HTML")
    args = parser.parse_args()

    root = args.path.expanduser().resolve()
    if not root.exists():
        parser.error(f"Путь не найден: {root}")
    if args.title and not root.is_file():
        parser.error("--title можно использовать только с одним файлом")
    out_dir = args.output_dir.expanduser().resolve()
    files = [root] if root.is_file() else sorted(path for path in root.rglob(args.glob) if path.is_file())
    written = 0

    for source in files:
        relative = source.relative_to(root) if root.is_dir() else Path(source.name)
        target = out_dir / relative.with_suffix(".html")
        if target.resolve() == source.resolve():
            print(f"Пропуск, выходной путь совпадает с входным: {source}")
            continue
        if target.exists() and not args.force:
            print(f"Пропуск, файл уже есть: {target}")
            continue
        target.parent.mkdir(parents=True, exist_ok=True)
        target.write_text(render(source, args.title, args.css), encoding="utf-8")
        written += 1
        print(f"Сохранено: {target}")
    print(f"Страниц собрано: {written}")
    return 0


if __name__ == "__main__":
    raise SystemExit(main())

Скрипты работают с файлами и настройками системы. Перед запуском прочитайте код и проверьте пути. Особенно если скрипт удаляет, перезаписывает или перемещает данные.

CLI 1.0.0

Скачать без браузера

Команда скачает этот файл в текущую папку. CLI работает на Windows, macOS и Linux.

scriptdock get text-markdown-to-html
  • Поиск по всему каталогу
  • Python 3.10+
  • Без внешних пакетов
Скачать CLI

GUI-версия готовится. Подробнее

Категория

Текст и документы

Поиск, замена, кодировки, Markdown, CSV и работа с большими текстами.