From ffd79dbc611ccb68fcac1781b867bf3a4830d6e2 Mon Sep 17 00:00:00 2001 From: Warren Lo Date: Wed, 18 Mar 2026 21:44:28 +0800 Subject: [PATCH] Add PDF export feature documentation --- README.md | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 323cd75..ebb0165 100644 --- a/README.md +++ b/README.md @@ -9,6 +9,7 @@ A simple Markdown reader with Mermaid diagram support. - HTTP server for serving files - **Mermaid diagram support** with SVG export - Preview in browser +- Export to PDF via browser print ## Installation @@ -42,6 +43,18 @@ md_reader server -p 8080 -d ./docs/ md_reader preview document.md ``` +### Export to PDF + +```bash +# Method 1: Using export command +md_reader export document.md -o output.html + +# Method 2: Using render with -p flag +md_reader render document.md -p +``` + +Open the exported HTML file in browser, then use **File > Print > Save as PDF**. + ## Mermaid Support md_reader supports rendering Mermaid diagrams in Markdown files. @@ -50,12 +63,12 @@ md_reader supports rendering Mermaid diagrams in Markdown files. Use `mermaid` code blocks: -````markdown +```markdown ```mermaid graph TD A[Start] --> B[End] ``` -```` +``` ### Supported Diagram Types