# markdown-to-wechatmp

**Repository Path**: pojoin/markdown-to-wechatmp

## Basic Information

- **Project Name**: markdown-to-wechatmp
- **Description**: markdown转公众号文章
- **Primary Language**: Unknown
- **License**: MulanPSL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2026-02-25
- **Last Updated**: 2026-02-26

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# Markdown to WeChat MP

一个将 Markdown 转换为微信公众号文章 HTML 格式的 Rust 命令行工具。

## 功能特性

- 📝 **完整的 Markdown 支持**：支持标题、段落、列表、代码块、表格、图片、链接等常见 Markdown 元素
- 🎨 **可自定义主题**：通过 TOML 配置文件自定义 HTML 样式
- 📋 **剪贴板集成**：一键复制生成的 HTML 到剪贴板，方便粘贴到公众号编辑器
- 💾 **文件输出**：支持输出到指定 HTML 文件
- 🖼️ **图片优化**：自动为图片添加圆角、阴影等微信公众号友好的样式
- 📊 **表格美化**：支持表头高亮和斑马纹样式
- 🔤 **代码高亮**：代码块带有优雅的背景和圆角样式

## 安装

### 从源码编译

```bash
git clone https://github.com/yourusername/markdown-to-wechatmp.git
cd markdown-to-wechatmp
cargo build --release
```

编译完成后，可执行文件位于 `target/release/markdown-to-wechatmp.exe`（Windows）或 `target/release/markdown-to-wechatmp`（Linux/macOS）。

## 使用方法

### 基本用法

```bash
# 将 Markdown 文件转换为 HTML 并输出到文件
markdown-to-wechatmp -i input.md -o output.html

# 将生成的 HTML 复制到剪贴板
markdown-to-wechatmp -i input.md --clipboard

# 使用自定义主题
markdown-to-wechatmp -i input.md -o output.html -t my-theme.toml

# 输出到标准输出
markdown-to-wechatmp -i input.md
```

### 命令行参数

| 参数 | 简写 | 说明 |
|------|------|------|
| `--input` | `-i` | 输入的 Markdown 文件路径（必填） |
| `--output` | `-o` | 输出的 HTML 文件路径（可选） |
| `--theme` | `-t` | 主题配置文件路径（可选，默认使用内置主题） |
| `--clipboard` | - | 将 HTML 复制到剪贴板而不是输出到文件 |

## 主题配置

工具使用 TOML 格式的主题配置文件来自定义 HTML 样式。默认主题位于 `themes/default.toml`。

### 创建自定义主题

```toml
# wrapper 包裹整个内容的样式
[wrapper]
style = "font-family: 'Microsoft YaHei', sans-serif; font-size: 16px; line-height: 1.8;"

# 标题样式
[heading.h1]
style = "margin: 40px 0 20px;"
prefix_style = "display: none;"
content_style = "font-size: 26px; font-weight: bold; color: #333;"
suffix_style = "display: none;"

[heading.h2]
style = "margin: 30px 0 15px;"
prefix_style = "display: none;"
content_style = "font-size: 22px; font-weight: bold; color: #333;"
suffix_style = "display: none;"

[heading.h3]
style = "margin: 25px 0 12px;"
prefix_style = "display: none;"
content_style = "font-size: 20px; font-weight: bold; color: #333;"
suffix_style = "display: none;"

# 段落样式
[paragraph]
style = "margin: 10px 0; text-indent: 2em;"

# 粗体样式
[strong]
style = "font-weight: bold; color: #000;"

# 斜体样式
[emphasis]
style = "font-style: italic;"

# 删除线样式
[strikethrough]
style = "text-decoration: line-through; color: #888;"

# 链接样式
[link]
style = "color: #007AFF; text-decoration: none;"

# 列表样式
[list]
style = "list-style-type: disc; margin: 10px 0; padding-left: 25px;"

[list_item]
style = "margin: 5px 0;"

# 代码块样式
[code_block]
pre_style = "background: #f8f9fa; border-radius: 8px; padding: 16px; overflow-x: auto;"
header_style = "display: none;"
code_style = "font-family: 'Consolas', monospace; font-size: 14px; color: #333;"

# 行内代码样式
[inline_code]
style = "background: #f0f0f0; padding: 2px 6px; border-radius: 4px; font-family: monospace;"

# 图片样式
[image.figure]
style = "text-align: center; margin: 20px 0;"

[image.img]
style = "max-width: 100%; border-radius: 8px; box-shadow: 0 2px 8px rgba(0,0,0,0.1);"

[image.caption]
style = "text-align: center; color: #666; font-size: 14px; margin-top: 8px;"

# 表格样式
[table]
style = "width: 100%; border-collapse: collapse; margin: 20px 0;"

[table_cell]
head_style = "background: #f5f5f5; font-weight: bold; padding: 12px; border: 1px solid #ddd;"
data_style = "padding: 12px; border: 1px solid #ddd;"

# 引用块样式
[blockquote]
style = "border-left: 4px solid #007AFF; padding-left: 16px; margin: 20px 0; color: #666;"

# 分割线样式
[hr]
style = "border: none; border-top: 1px solid #ddd; margin: 30px 0;"
```

### 使用自定义主题

```bash
markdown-to-wechatmp -i article.md -o article.html -t themes/my-custom-theme.toml
```

## 支持的 Markdown 语法

- [x] 标题（H1-H6）
- [x] 段落和换行
- [x] 粗体、斜体、删除线
- [x] 有序列表和无序列表
- [x] 链接和图片
- [x] 代码块和行内代码
- [x] 引用块
- [x] 分割线
- [x] 表格
- [x] 任务列表

## 示例

### 输入 Markdown

```markdown
# 文章标题

这是一段**粗体**和*斜体*的文字。

## 代码示例

```rust
fn main() {
    println!("Hello, WeChat!");
}
```

## 列表示例

- 第一项
- 第二项
- 第三项
```

### 输出 HTML

生成的 HTML 可以直接复制到微信公众号编辑器中使用。

## 开发

### 运行测试

```bash
cargo test
```

### 运行示例

```bash
cargo run -- -i test.md -o output.html
```

## 项目结构

```
markdown-to-wechatmp/
├── src/
│   ├── main.rs      # 程序入口
│   ├── cli.rs       # 命令行参数解析
│   ├── lib.rs       # 库模块导出
│   ├── parser.rs    # Markdown 解析器
│   ├── generator.rs # HTML 生成器
│   ├── theme.rs     # 主题配置
│   └── error.rs     # 错误处理
├── tests/           # 集成测试
├── themes/          # 主题配置文件
│   └── default.toml # 默认主题
├── Cargo.toml
└── README.md
```

## 性能测试

在 Windows 10 系统上进行的性能测试结果：

### 测试环境

- **操作系统**: Windows 10
- **CPU**: 现代多核处理器
- **内存**: 16GB+
- **Rust 版本**: 1.85+

### 可执行文件大小

| 项目 | 大小 |
|------|------|
| 发布版本可执行文件 | ~1.43 MB |

### 运行速度

测试方法：对每个文件运行 10 次转换，取平均值

| 测试文件 | 输入大小 | 输出大小 | 平均耗时 | 最快 | 最慢 |
|----------|----------|----------|----------|------|------|
| test.md（小文件） | 12.58 KB | 43.26 KB | ~35 ms | ~26 ms | ~111 ms |
| large_test.md（大文件） | 8.09 KB | 62.32 KB | ~36 ms | ~26 ms | ~116 ms |

**结论**：程序运行速度非常快，即使是较大的 Markdown 文件也能在 **50ms 以内** 完成转换。

### 内存占用

由于程序执行速度极快（毫秒级），进程在内存监控工具捕获前已完成退出。根据 Rust 程序的内存特性估算：

| 指标 | 估算值 |
|------|--------|
| 启动内存 | ~2-5 MB |
| 峰值内存 | ~5-10 MB |
| 运行时内存占用 | 极低 |

**结论**：程序内存占用非常低，适合在各种配置的设备上运行。

### 与其他工具对比

| 工具类型 | 启动时间 | 内存占用 | 依赖 |
|----------|----------|----------|------|
| 本工具 (Rust) | ~35ms | ~5MB | 无（单可执行文件） |
| Node.js 工具 | 200-500ms | 50-100MB | 需要 Node.js 运行时 |
| Python 工具 | 100-300ms | 30-80MB | 需要 Python 解释器 |

## 依赖项

- [clap](https://crates.io/crates/clap) - 命令行参数解析
- [pulldown-cmark](https://crates.io/crates/pulldown-cmark) - Markdown 解析器
- [serde](https://crates.io/crates/serde) - 序列化/反序列化
- [toml](https://crates.io/crates/toml) - TOML 配置文件解析
- [arboard](https://crates.io/crates/arboard) - 剪贴板操作

## 许可证

MIT License

## 贡献

欢迎提交 Issue 和 Pull Request！