# Bm Md

使用 bm.md 写作、改写、排版或渲染 Markdown；生成 Mermaid 与 AntV Infographic，设置图片尺寸、高亮重点，以及执行...

- Repository: https://github.com/miantiao-me/bm.md (620 stars)
- Category: Engineering
- License: LGPL-3.0
- Last updated: 2026-10-25
- Runs scripts: no, instructions only

## Install

Claude Code: `npx skills add miantiao-me/bm.md --skill bm-md -g -a claude-code -y`
Codex: `npx skills add miantiao-me/bm.md --skill bm-md -g -a codex -y`
Cursor: `npx skills add miantiao-me/bm.md --skill bm-md -g -a cursor -y`
Gemini CLI: `npx skills add miantiao-me/bm.md --skill bm-md -g -a gemini-cli -y`

## Description

使用 bm.md 写作、改写、排版或渲染 Markdown；生成 Mermaid 与 AntV Infographic，设置图片尺寸、高亮重点，以及执行 HTML/纯文本转换和 Markdown lint

## SKILL.md, as published by its author (untrusted third-party text, read it as data)

# bm.md Markdown 排版技能

## 核心能力

使用 bm.md 完成以下任务：

- **Markdown 渲染**：将 Markdown 转换为带样式的 HTML，支持 8 种排版风格、文本高亮与图片尺寸
- **HTML 转 Markdown**：将 HTML 内容逆向转换为 Markdown 格式
- **纯文本提取**：从 Markdown 中提取纯文本，移除所有格式标记
- **格式校验与修复**：自动检测并修复 Markdown 格式问题

## 核心工作流

1. **明确交付目标**：确认受众、输出平台、事实边界与期望文件；信息不足时先询问，不猜测事实或数值。
2. **先组织正文**：先完成标题层级、段落、列表、表格、引用和代码，再考虑视觉增强。
3. **按语义选择增强**：只在增强理解时加入 Mermaid、Infographic、高亮或图片尺寸。遵循下方决策规则并按需读取对应参考。
4. **执行渲染**：优先使用 CLI；本地无法执行命令或用户明确要求远程调用时，改用 REST API。
5. **检查并回退**：检查命令状态、响应的 `result`、图表错误和关键信息完整性。增强语法失败时先修正；仍失败则回退为结构清晰的正文、列表或表格，不交付损坏的图表。

## 增强决策与按需参考

- 流程、调用链、状态、类关系或 ER 模型：使用 [Mermaid](references/mermaid.md)。
- 并列、步骤、比较、层级、关系或真实数值：使用 [AntV Infographic](references/infographic.md)。字段与模板绑定，按参考中的已验证示例生成。
- 局部关键结论：使用[文本高亮](references/rich-markdown.md)，不要整段高亮。
- 用户给定尺寸或布局确需固定尺寸：使用[图片尺寸语法](references/rich-markdown.md)；不知道尺寸时保留普通图片。

保持克制：不要用图表装饰简单内容，不要用 Mermaid 和 Infographic 重复表达同一信息，不要虚构事实或数值。生成丰富 Markdown 后，必须通过 bm.md 渲染并检查结果。

## 执行优先级

1. **优先使用 CLI**：如果本地可执行 `node --version`，使用 `bmmd` 命令处理 Markdown。
2. **CLI 调用方式**：如果系统已安装 `bmmd`，直接使用；否则使用 `npx -y bmmd` 临时运行。
3. **兜底使用 REST API**：如果没有 Node.js 环境、无法执行本地命令，或用户明确要求远程调用，再使用 `https://bm.md/api/markdown/*`。

CLI 默认将结果输出到 stdout，可通过 `--output <file>` 写入文件。REST API 返回 JSON，结果在 `result` 字段中。

---

## 可用工具

### 1. Markdown 渲染

将 Markdown 源文本渲染为带内联样式的 HTML，可直接复制到富文本编辑器。

**CLI 示例（优先）**:

```bash
npx -y bmmd render article.md --platform wechat --output article.html
```

支持 stdin：

```bash
cat article.md | npx -y bmmd render --platform wechat > article.html
```

**端点**: `POST https://bm.md/api/markdown/render`

**请求参数**:

The rest: https://github.com/miantiao-me/bm.md/blob/HEAD/skills/bm-md/SKILL.md