/install md-pdf
md2pdf
Produce polished, print-ready PDF from Markdown with a stable, reusable pipeline.
Quick start
- Install dependencies (Ubuntu/Debian):
bash scripts/install_deps_ubuntu.sh
- Convert standard formal Markdown with Pandoc/XeLaTeX:
bash scripts/md2pdf.sh input.md output.pdf
- Convert emoji-heavy or browser-like Markdown with CDP browser rendering:
bash scripts/md2pdf-browser.sh input.md output.pdf
- Optional: enable cover page / metadata style via defaults:
bash scripts/md2pdf.sh input.md output.pdf --defaults assets/defaults/hifi.yaml
Workflow
1) Choose the pipeline
Use the LaTeX pipeline when the document is mostly text/tables and should look print-formal.
Use the browser pipeline when any of these are true:
- emoji must render correctly
- HTML/CSS-like appearance matters more than TeX typography
- the Markdown contains GitHub-style formatting that is easier to preserve in HTML
- a CDP browser endpoint is already available
2) Prepare source markdown
- Prefer
#/##heading hierarchy (for TOC quality). - Keep code blocks fenced with language tags (for syntax highlight).
- Keep tables in GFM format.
- For very wide tables, prefer shorter cell content or convert the summary table to bullets before export.
3) Run the formal print pipeline
Use scripts/md2pdf.sh as the default entrypoint for print-style output.
It applies a professional baseline:
--pdf-engine=xelatex- Chinese font fallback (
Noto Sans CJK SC) - Table of contents (
--toc) - Section numbering (
--number-sections) - Reasonable margins / line spread / link coloring
- Code highlight style
4) Run the emoji-friendly browser pipeline
Use scripts/md2pdf-browser.sh when emoji support matters.
It does this:
- render Markdown to HTML
- convert emoji to Twemoji images
- connect to an existing CDP browser (
BROWSER_CDP_URLorhttp://127.0.0.1:9222) - print the page to PDF with browser CSS
Example:
BROWSER_CDP_URL=http://192.168.1.30:9222 bash scripts/md2pdf-browser.sh input.md output.pdf
5) Tune output quality
Use either:
- CLI flags in
scripts/md2pdf.sh(quick tuning), or - defaults file (
assets/defaults/hifi.yaml) for stable team-wide style.
Recommended adjustments:
- business report: keep
11pt, margin2.2cm, TOC on - printable manual: increase margin to
2.5cm - dense technical doc: keep section numbers and monospace code font
- emoji-heavy travel/share docs: prefer browser pipeline first
Troubleshooting
pandoc: command not found: runscripts/install_deps_ubuntu.sh.xelatex not found: ensuretexlive-xetexinstalled, or switch toscripts/md2pdf-browser.sh.- Emoji missing in PDF: use
scripts/md2pdf-browser.sh; TeX engines are often poor at color emoji. - CJK glyph squares/tofu: install
fonts-noto-cjkand keepCJKmainfontas Noto Sans CJK. - Browser script cannot connect: pass a valid CDP URL as arg 3 or set
BROWSER_CDP_URL. - Weird table wrapping: reduce table width in markdown or use bullets for wide summary tables.
References
- Style baseline and knobs:
references/style-guide.md - Reusable defaults preset:
assets/defaults/hifi.yaml
- 确保已安装 OpenClaw(本地或 Docker 部署)
- 在对话框中输入安装命令:
/install md-pdf - 安装完成后,直接呼叫该 Skill 的名称或使用
/md-pdf触发 - 根据 Skill 的参数说明提供必要输入,即可获得结构化输出
md-pdf 是什么?
Convert Markdown to polished PDF using Pandoc + XeLaTeX for print-quality or browser rendering with emoji and CSS support for rich visuals. 它是一个面向 Claude Code / OpenClaw 的 AI Agent Skill 插件,目前累计下载 184 次。
如何安装 md-pdf?
在 OpenClaw 或 Claude Code 对话框中运行命令「/install md-pdf」即可一键安装,无需额外配置。
md-pdf 是免费的吗?
是的,md-pdf 完全免费,采用 MIT-0 许可证,可自由下载、安装和使用。
md-pdf 支持哪些平台?
md-pdf 跨平台运行,可在任意部署了 OpenClaw / Claude Code 的环境中使用(cross-platform)。
谁开发了 md-pdf?
由 Karl Zhu(@karlzhu-zxc)开发并维护,当前版本 v1.0.1。