md2x 0.7.3 → 0.7.5

package/README.md

@@ -1,11 +1,16 @@
 # md2x
 
-Markdown → PDF/DOCX/HTML/Image converter (local, no server). Supports Mermaid/Graphviz/Infographic/Vega/Template(vue/svelte/html) rendering, math, and code highlighting.
-
-> Supports MCP tools and md2x skill. 🎉
+Markdown → PDF/DOCX/HTML/Image converter.
 
 [![npm version](https://img.shields.io/npm/v/md2x.svg?style=flat-square)](https://www.npmjs.com/package/md2x)
 
+## Features
+
+- 📦 **Supported formats**: `pdf`, `docx`, `html`, `png`, `jpg/jpeg`, `webp`
+- 🔌 **MCP (Model Context Protocol)**: run `mcp/` server to expose Markdown conversion as MCP tools
+- 🧠 **Skills**: includes an agent skill at `skills/md2x/SKILL.md` for repeatable conversions/workflows
+- 🧩 **Custom templates**: render `md2x` blocks with **Vue SFC** (`.vue`) and **Svelte 5** (`.svelte`) templates (plus plain HTML)
+
 ## CLI Usage
 
 Export to PDF:
@@ -59,13 +64,15 @@ npx md2x -h
 | `--format` | `-f` | Output format | `pdf` | `pdf`, `docx`, `html`, `png`, `jpg/jpeg`, `webp` |
 | `--theme` | `-t` | Theme name | `default` | See `--list-themes` |
 | `--diagram-mode` | - | HTML/Image diagram rendering mode | `live` | `img`, `live`, `none` |
+| `--live-runtime` | - | HTML live runtime injection strategy (only when `diagramMode: live`) | `cdn` | `inline`, `cdn` |
+| `--live-runtime-url` | - | Custom runtime URL when `--live-runtime cdn` | - | URL |
 | `--hr-page-break` | - | Convert horizontal rules to page breaks | `true` for PDF/DOCX, `false` for HTML/Image | `true`, `false` |
 | `--templates-dir` | - | Extra template dir for md2x blocks (repeatable; resolved against input dir when relative) | - | Directory path |
 | `--list-themes` | - | List all available themes | - | - |
 
 ### Diagram Modes (HTML/Image)
 
-- **`live`** (default): Render diagrams in the browser on load using online CDN scripts (Mermaid, @viz-js/viz, Vega-Lite, Infographic)
+- **`live`** (default): Render diagrams in the browser on load using the md2x live runtime (by default it is embedded into the output HTML; see `liveRuntime` below)
 - **`img`**: Pre-render diagrams as embedded images (offline, stable; no CDN)
 - **`none`**: Keep diagram source blocks only (no rendering)
 
@@ -124,6 +131,8 @@ title: "My Doc"
 standalone: true    # full HTML document (default)
 baseTag: true       # emit <base href="file://.../"> for resolving relative paths (default)
 diagramMode: live   # img | live | none
+liveRuntime: cdn    # inline | cdn (default: cdn). Use "inline" for fully self-contained HTML.
+# liveRuntimeUrl: "https://cdn.jsdelivr.net/npm/md2x@0.7.3/dist/renderer/" # chunked runtime base URL
 cdn:                # optional: override CDN URLs (used when diagramMode: live)
   mermaid: "https://cdn.jsdelivr.net/npm/mermaid@11.12.2/dist/mermaid.min.js"
   # Template blocks:
@@ -241,10 +250,11 @@ const data = templateData;
 
 ### Template Resolution (External Templates)
 
-To load templates from outside the built-in `dist/templates`, use either:
+To load templates from outside, use:
 
-- CLI: `--templates-dir /path/to/templates` (repeatable)
-- Front matter: `templatesDir: /path/to/templates` (string or list)
+- CLI: `--templates-dir /path/to/templates` (repeatable; CLI reads files and passes them as `templates`)
+- Library API: pass `templates: Record<string, string>` (you can load files yourself if you want)
+- Front matter: `templates:` supports inline template sources (YAML map)
 
 ### CDN Overrides (Live Mode)