Convert Markdown files to self-contained HTML pages with GitHub-like styling
Project description
Read this in English | GitHub | PyPI
md-to-html-converter
md-to-html-converter — это Python-библиотека и CLI-утилита для конвертации Markdown-файлов (.md) в самодостаточные HTML-страницы (.html) с оформлением в стиле GitHub.
Возможности
- Полная поддержка Markdown — таблицы, блоки кода, списки, цитаты и всё остальное через библиотеку
markdownс расширениями. - Подсветка синтаксиса — блоки кода подсвечиваются с помощью Pygments (цветовые схемы, приближенные к GitHub).
- Тёмная и светлая темы — GitHub Dark (по умолчанию) и GitHub Light. Все стили встраиваются прямо в HTML-файл (self-contained).
- Эмодзи — шорткоды вида
:smile:автоматически заменяются на Unicode-эмодзи (😄). - Якорные ссылки — у каждого заголовка (
<h1>–<h6>) появляется уникальныйidи ссылка-якорь, видимая при наведении. - Транслитерация — кириллические заголовки преобразуются в латинские slug-и (например,
# Привет мир→privet-mir). - Python API и CLI — используйте библиотеку в своём коде или вызывайте
md-converterиз терминала.
Установка
pip install md-to-html-converter
Использование
Python API
import md_to_html_converter as convert
# Конвертация файла (GitHub Dark)
convert.file("document.md", "document.html")
# Конвертация файла (GitHub Light)
convert.file("document.md", "document.html", theme="light")
# Конвертация строки
html = convert.convert("# Hello\n\nWorld!", theme="dark")
with open("page.html", "w", encoding="utf-8") as f:
f.write(html)
CLI
# GitHub Dark (по умолчанию)
md-converter input.md output.html
# GitHub Light
md-converter input.md output.html --theme light
# Явное указание тёмной темы
md-converter input.md output.html --theme dark
Пример
Входной файл example.md:
# Привет, мир!
Это **пример** Markdown-документа.
| Имя | Возраст |
|------|---------|
| Анна | 25 |
| Иван | 30 |
```python
def hello():
print("Hello!")
Цитата с :smile:
**Команда:**
```bash
md-converter example.md example.html --theme dark
Результат: самодостаточный HTML-файл example.html с GitHub-подобным тёмным оформлением, подсветкой синтаксиса и якорными ссылками.
Требования
- Python 3.8 или выше
- Зависимости:
markdown>=3.3,Pygments>=2.14,emoji>=2.0
Структура проекта
md-to-html-converter/
├── pyproject.toml
├── LICENSE
├── README.md
├── README.en.md
└── src/
└── md_to_html_converter/
├── __init__.py
└── converter.py
Лицензия
Apache 2.0
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file md_to_html_converter-1.1.tar.gz.
File metadata
- Download URL: md_to_html_converter-1.1.tar.gz
- Upload date:
- Size: 19.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
fcc299ad6e61590d942518031a761f887eb1523ad0f1ae167edc478cd812fa0c
|
|
| MD5 |
c081a5c2c70090bd994a5e025e51240e
|
|
| BLAKE2b-256 |
3222dc9718dfa0019b720497016b5523bc7852a20d514d50417f50bbdea79ca8
|
File details
Details for the file md_to_html_converter-1.1-py3-none-any.whl.
File metadata
- Download URL: md_to_html_converter-1.1-py3-none-any.whl
- Upload date:
- Size: 12.4 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.2.0 CPython/3.14.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
e74add4acc3ec9fa5c55a29cd025fd0154a48464c06ab6b0adb2a8112019eb26
|
|
| MD5 |
699e165743f18d129a7b31793cbe5bdb
|
|
| BLAKE2b-256 |
8f10deb200650e9d4265d4be645dc7c82ce8b0f5836e555a6b2b42cf87972fff
|