MD to HTML Converter (md2html-nav)

A Markdown-to-HTML converter that transforms plain Markdown into a HTML documentation page. This tool is ideal for technical documentation, wikis, engineering blogs, API docs, and project pages.

📚 Table of Contents

- ✨ Install (NPM)
- 🚀 Usage (CLI)
- 💡 Why This Tool?
- 📘 Description
- 🧩 Template Features Explained
- Sidebar Table of Contents
- Minimap Navigation
- Syntax Highlighting
- Mermaid Diagram Support
- Scroll Progress Bar
- ScrollSpy
- Copy Code Buttons
- Theme Switcher
- Floating Back-to-Top Button
- 📦 Installation
- ▶️ Usage Examples
- 🐞 Reporting Issues
- 🤝 Contributing
- 📄 License
- 📬 Contact

---

✨ Install (NPM)

``bash
npm install -g md2html-nav
`

This installs the CLI globally so you can run the converter from anywhere.

---

🚀 Usage (CLI)

Convert a Markdown file into a polished HTML document:

`bash
md2html-nav input.md output.html
`

Example:

`bash
md2html-nav README.md docs.html
`

This generates a fully‑styled HTML page using the built‑in template, sidebar TOC, minimap, syntax highlighting, Mermaid diagrams, theme switching, scroll progress, and FAB-to-top.

---

⚡ Mode Comparison (Default vs Standalone vs Copy Assets)

| Mode | Command | Output | Offline Support | JS/CSS Handling | Best For |
|------|---------|--------|-----------------|-----------------|----------|
| Default | md2html-nav in.md out.html | Single HTML | ❌ Partial | References external scripts & CDN CSS | Hosting with own asset pipeline |
| Standalone | md2html-nav in.md out.html --standalone | Single HTML | ✅ Full | JS + CSS are inlined | Email, sharing, GitHub wiki, S3 |
| Copy Assets | md2html-nav in.md out.html --copy-scripts | HTML + assets/ folder | ✅ Full | JS + CSS copied locally | Offline sites, GitHub Pages, docs folders |

Examples:

`bash


Single self-contained HTML (recommended for sharing)

md2html-nav guide.md guide.html --standalone

Output HTML + JS/CSS copied next to it

md2html-nav handbook.md handbook.html --copy-scripts
`

---

🔥 Mode Details (Impact & Use Cases)

$3

`
md2html-nav input.md output.html
`
- Injects Markdown into template
- Leaves external