Skip to main content

mdparser-html is a lightweight and extensible Markdown → HTML converter with a clean Python API and CLI.

Project description

mdparser-html

A lightweight, extensible Markdown → HTML converter with a clean Python API and CLI.

Built for simplicity, hackability, and future extension.


🤔 Why mdparser-html?

  • Lightweight alternative to full Markdown engines
  • Easy to extend and hack
  • Designed for learning, tooling, and static generators

✨ Features

  • Markdown → HTML conversion
  • Full HTML document or body-only output
  • Syntax highlighting via CDN (Prism / Highlight.js)
  • Headings, lists, code blocks, images
  • Fenced blocks (:::)
  • CLI + Python API
  • Zero runtime dependencies

📦 Installation

pip install mdparser-html

🚀 Usage CLI

md2html input.md -o output.html

</> Python API

Basic usage

from mdparser import parse_markdown

html = parse_markdown("# Hello World")
print(html)

⚙️ Configuration Options

Advanced usage

html = parse_markdown(
    markdown_text,
    full_html=True,
    title="My Document",
    include_cdn=True  # Include syntax highlighting CDN links
)
print(html)

Body-only output

body = parse_markdown(markdown_text, full_html=False)
print(body)

Fenced blocks

:::

# Welcome

This is a hero section
:::

rendered as

<div class="hero">
  <h1>Welcome</h1>
  <p>This is a hero section</p>
</div>

🗂️ Supported Markdown

  • Headings (#########)
  • Bold / Italic
  • Inline code
  • Fenced code blocks
  • Ordered & unordered lists
  • Images
  • Fenced div blocks

🛠 Design Notes

  • Single public API: parse_markdown
  • Internal helpers are intentionally hidden
  • Designed for future renderers (HTML today, more later)

🧾 CHANGELOG.md

Create a new file called CHANGELOG.md

🗺 Roadmap

  • AST-based parser
  • Performance optimizations
  • Additional output formats (e.g. Pug)
  • Plugin hooks

🤝 Contributing

Pull requests are welcome.
Please open an issue before major changes.

License

MIT License © 2025 Tarun Nayaka R (Rtarun3606k)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

mdparser_html-0.2.1.tar.gz (8.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

mdparser_html-0.2.1-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file mdparser_html-0.2.1.tar.gz.

File metadata

  • Download URL: mdparser_html-0.2.1.tar.gz
  • Upload date:
  • Size: 8.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for mdparser_html-0.2.1.tar.gz
Algorithm Hash digest
SHA256 dfd7d065167b752462ce4ac0948223fd0f0fe1a24f1ad1c98f867588584a4dd0
MD5 1bf155cebfad282d1f220c6e957c12b0
BLAKE2b-256 d74e40cb8d4b919f6936cf93a63175dfe54399406b00f1c49780dad4d803feab

See more details on using hashes here.

File details

Details for the file mdparser_html-0.2.1-py3-none-any.whl.

File metadata

  • Download URL: mdparser_html-0.2.1-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.2

File hashes

Hashes for mdparser_html-0.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 4cb3abc8640b16301b55cdfe5966cc87efd1cfbab2f76a061a35d56f5acecfc9
MD5 836070c2a872c9e0cfb7b55579489ce3
BLAKE2b-256 53443b87ad73dbdbe8096b1618c6be98ac0a36908dc7189e9fe6bc521b280df7

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page