PluginBench
Skill
Review
Audit score 70

baoyu-markdown-to-html

jimliu/baoyu-skills

Convert Markdown to styled HTML with WeChat-compatible themes, code highlighting, math, and Mermaid diagrams.

What is baoyu-markdown-to-html?

Transforms Markdown files into beautifully styled HTML with inline CSS, optimized for WeChat Official Accounts and other platforms. Supports code highlighting, mathematical notation, Mermaid diagrams (rendered to PNG), PlantUML, footnotes, alerts, and optional bottom citations for external links.

  • Converts Markdown to HTML with inline CSS styling
  • Renders Mermaid diagrams to PNG via headless Chrome with caching
  • Supports code syntax highlighting, math notation, footnotes, and alerts
  • Provides multiple themes (default, grace, simple, modern) with customizable colors and fonts
  • Converts external links to bottom citations (引用链接) when enabled
  • Handles Chinese content detection and optional pre-formatting

How to install baoyu-markdown-to-html

npx skills add https://github.com/jimliu/baoyu-skills --skill baoyu-markdown-to-html
Prerequisites
  • bun or npx installed (bun preferred for performance)
  • Headless Chrome/Chromium available (for Mermaid PNG rendering)
  • Input Markdown file with optional YAML frontmatter
Claude Code
Cursor
Windsurf
Cline

How to use baoyu-markdown-to-html

  1. 1.Prepare your Markdown file with optional YAML frontmatter (title, author, summary)
  2. 2.Run the converter: `${BUN_X} {baseDir}/scripts/main.ts <markdown_file> --theme <theme_name>`
  3. 3.Optionally enable bottom citations with `--cite` flag for external links
  4. 4.Customize appearance with `--color`, `--font-family`, `--font-size` options
  5. 5.Retrieve the generated HTML file from the same directory as your input Markdown

Use cases

Good for
  • Convert technical documentation or blog posts to styled HTML for WeChat Official Accounts
  • Generate beautifully formatted articles with embedded diagrams and code examples
  • Create styled HTML output with custom branding via theme and color options
  • Convert Markdown with complex diagrams (Mermaid, PlantUML) to self-contained HTML
  • Transform articles with external links into citation-based format for WeChat sharing
Who it's for
  • Content creators publishing to WeChat Official Accounts
  • Technical writers converting documentation to styled HTML
  • Developers needing Markdown-to-HTML conversion with diagram support
  • Teams managing multi-platform content distribution

baoyu-markdown-to-html FAQ

What themes are available?

Four themes: default, grace, simple, and modern. Each has a distinct visual style and can be customized with color presets (blue, green, vermilion, yellow, purple, sky, rose, olive, black, gray, pink, red, orange) or custom hex values.

How are Mermaid diagrams handled?

Mermaid code blocks are automatically rendered to PNG images via headless Chrome and cached in `imgs/.mermaid-cache/`. Use `--no-mermaid` to skip rendering and output fallback `<pre class="mermaid">` blocks instead.

What happens if the output HTML file already exists?

The existing HTML file is automatically backed up with a timestamp suffix (e.g., `article.html.bak-20260128180000`) before the new file is written.

Can I use this for WeChat Official Accounts?

Yes, the HTML is specifically optimized for WeChat with inline CSS. Enable `--cite` to convert external links to bottom citations, which is WeChat-friendly. Note: WeChat links (https://mp.weixin.qq.com/...) remain as direct links.

What does the citation mode do?

When `--cite` is enabled, ordinary external links are converted to numbered superscripts and collected in a final `引用链接` (References) section at the bottom. Bare links (where text equals URL) and WeChat links stay inline.

Full instructions (SKILL.md)

Source of truth, from jimliu/baoyu-skills.


name: baoyu-markdown-to-html description: Converts Markdown to styled HTML with WeChat-compatible themes. Supports code highlighting, math, Mermaid (rendered to PNG via headless Chrome), PlantUML, footnotes, alerts, infographics, and optional bottom citations for external links. Use when user asks for "markdown to html", "convert md to html", "md 转 html", "微信外链转底部引用", or needs styled HTML output from markdown. version: 1.117.3 metadata: openclaw: homepage: https://github.com/JimLiu/baoyu-skills#baoyu-markdown-to-html requires: anyBins: - bun - npx

Markdown to HTML Converter

Converts Markdown files to beautifully styled HTML with inline CSS, optimized for WeChat Official Account and other platforms.

User Input Tools

When this skill prompts the user, follow this tool-selection rule (priority order):

  1. Prefer built-in user-input tools exposed by the current agent runtime — e.g., AskUserQuestion, request_user_input, clarify, ask_user, or any equivalent.
  2. Fallback: if no such tool exists, emit a numbered plain-text message and ask the user to reply with the chosen number/answer for each question.
  3. Batching: if the tool supports multiple questions per call, combine all applicable questions into a single call; if only single-question, ask them one at a time in priority order.

Concrete AskUserQuestion references below are examples — substitute the local equivalent in other runtimes.

Script Directory

Agent Execution: Determine this SKILL.md directory as {baseDir}. Resolve ${BUN_X} runtime: if bun installed → bun; if npx available → npx -y bun; else suggest installing bun. Replace {baseDir} and ${BUN_X} with actual values.

ScriptPurpose
scripts/main.tsMain entry point

Preferences (EXTEND.md)

Check EXTEND.md in priority order — the first one found wins:

PriorityPathScope
1.baoyu-skills/baoyu-markdown-to-html/EXTEND.mdProject
2${XDG_CONFIG_HOME:-$HOME/.config}/baoyu-skills/baoyu-markdown-to-html/EXTEND.mdXDG
3$HOME/.baoyu-skills/baoyu-markdown-to-html/EXTEND.mdUser home

If none found, use defaults.

EXTEND.md supports: default theme, custom CSS variables, code block style, mermaid defaults (mermaid_theme, mermaid_scale, mermaid_background).

Workflow

Step 0: Pre-check (Chinese Content)

Condition: Only execute if input file contains Chinese text.

Detection:

  1. Read input markdown file
  2. Check if content contains CJK characters (Chinese/Japanese/Korean)
  3. If no CJK content → skip to Step 1

Format Suggestion:

If CJK content detected AND baoyu-format-markdown skill is available:

Use AskUserQuestion to ask whether to format first. Formatting can fix:

  • Bold markers with punctuation inside causing ** parse failures
  • CJK/English spacing issues

If user agrees: Invoke baoyu-format-markdown skill to format the file, then use formatted file as input.

If user declines: Continue with original file.

Step 1: Determine Theme

Theme resolution order (first match wins):

  1. User explicitly specified theme (CLI --theme or conversation)
  2. EXTEND.md default_theme (this skill's own EXTEND.md, checked in Step 0)
  3. baoyu-post-to-wechat EXTEND.md default_theme (cross-skill fallback)
  4. If none found → use AskUserQuestion to confirm

Cross-skill EXTEND.md check (only if this skill's EXTEND.md has no default_theme):

Read $HOME/.baoyu-skills/baoyu-post-to-wechat/EXTEND.md if it exists and look for a default_theme: line. Use the value if present; otherwise fall through.

If theme is resolved from EXTEND.md: Use it directly, do NOT ask the user.

If no default found: use AskUserQuestion to confirm a theme from the Themes table below.

Step 1.5: Determine Citation Mode

Default: Off. Do not ask by default.

Enable only if the user explicitly asks for "微信外链转底部引用", "底部引用", "文末引用", or passes --cite.

Behavior when enabled:

  • Ordinary external links are rendered with numbered superscripts and collected under a final 引用链接 section.
  • https://mp.weixin.qq.com/... links stay as direct links and are not moved to the bottom.
  • Bare links where link text equals URL stay inline.

Step 2: Convert

${BUN_X} {baseDir}/scripts/main.ts <markdown_file> --theme <theme> [--cite]

Step 3: Report Result

Display the output path from JSON result. If backup was created, mention it.

Usage

${BUN_X} {baseDir}/scripts/main.ts <markdown_file> [options]

Options:

OptionDescriptionDefault
--theme <name>Theme name (default, grace, simple, modern)default
--color <name|hex>Primary color: preset name or hex valuetheme default
--font-family <name>Font: sans, serif, serif-cjk, mono, or CSS valuetheme default
--font-size <N>Font size: 14px, 15px, 16px, 17px, 18px16px
--title <title>Override title from frontmatter
--citeConvert external links to bottom citations, append 引用链接 sectionfalse (off)
--keep-titleKeep the first heading in contentfalse (removed)
--mermaid-theme <name>Mermaid theme: default, forest, dark, neutral, basedefault
--mermaid-scale <N>Mermaid render scale (positive number ≤ 4)2
--mermaid-width <N>Mermaid target display width in CSS px; PNG is rendered at width × scale pixels when the diagram is narrower than this860
--mermaid-bg <value>Mermaid background: white, transparent, or #hexwhite
--no-mermaidSkip Mermaid PNG rendering; emit <pre class="mermaid"> fallbackfalse
--helpShow help

Color Presets:

NameHexLabel
blue#0F4C81Classic Blue
green#009874Emerald Green
vermilion#FA5151Vibrant Vermilion
yellow#FECE00Lemon Yellow
purple#92617ELavender Purple
sky#55C9EASky Blue
rose#B76E79Rose Gold
olive#556B2FOlive Green
black#333333Graphite Black
gray#A9A9A9Smoke Gray
pink#FFB7C5Sakura Pink
red#A93226China Red
orange#D97757Warm Orange (modern default)

Examples:

# Basic conversion (uses default theme, removes first heading)
${BUN_X} {baseDir}/scripts/main.ts article.md

# With specific theme
${BUN_X} {baseDir}/scripts/main.ts article.md --theme grace

# Theme with custom color
${BUN_X} {baseDir}/scripts/main.ts article.md --theme modern --color red

# Enable bottom citations for ordinary external links
${BUN_X} {baseDir}/scripts/main.ts article.md --cite

# Keep the first heading in content
${BUN_X} {baseDir}/scripts/main.ts article.md --keep-title

# Override title
${BUN_X} {baseDir}/scripts/main.ts article.md --title "My Article"

Output

File location: Same directory as input markdown file.

  • Input: /path/to/article.md
  • Output: /path/to/article.html

Conflict handling: If HTML file already exists, it will be backed up first:

  • Backup: /path/to/article.html.bak-YYYYMMDDHHMMSS

JSON output to stdout:

{
  "title": "Article Title",
  "author": "Author Name",
  "summary": "Article summary...",
  "htmlPath": "/path/to/article.html",
  "backupPath": "/path/to/article.html.bak-20260128180000",
  "contentImages": [
    {
      "placeholder": "MDTOHTMLIMGPH_1",
      "localPath": "/path/to/img.png",
      "originalPath": "imgs/image.png"
    }
  ],
  "mermaidImages": [
    {
      "hash": "a1b2c3d4e5f6",
      "localPath": "/path/to/imgs/.mermaid-cache/mermaid-a1b2c3d4e5f6.png",
      "cached": false
    }
  ]
}

Mermaid rendering: Code blocks fenced as ```mermaid are rendered to PNGs via headless Chrome (CDP) and cached at imgs/.mermaid-cache/mermaid-<hash>.png. The cache key includes the code, theme, scale, target width, background, and mermaid version. Add imgs/.mermaid-cache/ to .gitignore if you do not want generated diagrams checked in. Requires Chrome/Chromium/Edge on the system; otherwise the block falls back to <pre class="mermaid">…</pre> and conversion still succeeds.

Themes

ThemeDescription
defaultClassic - traditional layout, centered title with bottom border, H2 with white text on colored background
graceElegant - text shadow, rounded cards, refined blockquotes (by @brzhang)
simpleMinimal - modern minimalist, asymmetric rounded corners, clean whitespace (by @okooo5km)
modernModern - large radius, pill-shaped titles, relaxed line height (pair with --color red for traditional red-gold style)

Supported Markdown Features

FeatureSyntax
Headings# H1 to ###### H6
Bold/Italic**bold**, *italic*
Code blocks```lang with syntax highlighting
Inline code`code`
TablesGitHub-flavored markdown tables
Images![alt](src)
Links[text](url); add --cite to move ordinary external links into bottom references
Blockquotes> quote
Lists- unordered, 1. ordered
Alerts> [!NOTE], > [!WARNING], etc.
Footnotes[^1] references
Ruby text`{base
Mermaid```mermaid blocks rendered to local PNG via headless Chrome (cached under imgs/.mermaid-cache/); falls back to <pre class="mermaid"> if Chrome is unavailable or rendering fails
PlantUML```plantuml diagrams

Frontmatter

Supports YAML frontmatter for metadata:

---
title: Article Title
author: Author Name
description: Article summary
---

If no title is found, extracts from first H1/H2 heading or uses filename.

Extension Support

Custom configurations via EXTEND.md. See Preferences section for paths and supported options.