mk2html Documentation
Welcome to the mk2html documentation! This guide covers everything you need to know about converting Markdown to beautiful HTML and PDF documents.
Table of Contents
- Getting Started
- mk2html - HTML Converter
- mk2pdf - PDF Converter
- Configuration Options
- Examples
- API Reference
- Contributing
- Changelog
Quick Links
| Document | Description |
|---|---|
| Getting Started | Installation and first steps |
| mk2html | Complete guide to HTML conversion |
| mk2pdf | Complete guide to PDF conversion |
| Examples | Real-world usage examples |
Features Overview
mk2html Features
- 🎨 Beautiful, modern styling with CSS variables
- 📑 Auto-generated table of contents
- 🌙 Dark/Light mode toggle with persistence
- 📊 Mermaid diagram rendering
- 💻 Syntax highlighting for code blocks
- 📱 Responsive design
- 🔢 Line numbers in code blocks
- ⚡ Offline mode with cached libraries
mk2pdf Features
- 📄 High-quality PDF output
- 📊 Full Mermaid diagram support
- 💻 Preserved syntax highlighting
- 📏 Configurable page sizes (A4, Letter, Legal, etc.)
- 📐 Custom margins and orientation
- 🔄 Automatic Chromium installation
Support
- GitHub Issues: https://github.com/km1790/mk2html/issues
- Repository: https://github.com/km1790/mk2html