@mcpcn/markdown-converter-mcp 1.0.4 → 1.0.6

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md CHANGED
@@ -1,214 +1,210 @@
1
- # 统一Markdown转换MCP服务器
2
-
3
- [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
4
- [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
5
- [![MCP](https://img.shields.io/badge/MCP-1.0-orange.svg)](https://modelcontextprotocol.io/)
6
-
7
- 一个功能强大的MCP (Model Context Protocol) 服务器,支持将Markdown文档转换为PDF和Word格式。**特别优化了代码块显示效果**,确保在转换后的文档中代码的完美呈现。
8
-
9
- ## ✨ 主要特性
10
-
11
- ### 🔄 双格式支持
12
- - **PDF转换**: 高质量PDF生成,支持模板、水印、语法高亮等高级功能
13
- - **Word转换**: 专业级Word文档生成,**特别优化代码块显示效果**
14
-
15
- ### 🎨 丰富的自定义选项
16
- - **PDF模板**: default, academic, modern 三种预设模板
17
- - **Word主题**: default, github, dark, minimal 四种代码块主题
18
- - **自定义样式**: 字体、颜色、间距等完全可定制
19
-
20
- ### ⚡ 性能优化
21
- - **智能缓存**: 文件系统 + 内存双重缓存机制
22
- - **并发控制**: 资源池管理,支持批量转换
23
- - **增量处理**: 避免重复转换,提高效率
24
-
25
- ## 🛠️ 可用工具
26
-
27
- ### 1. `convert_to_pdf` - PDF转换
28
- 将Markdown内容或文件转换为PDF文件。
29
-
30
- **参数:**
31
- - `markdown` (必填): Markdown内容或.md文件路径
32
- - `outputPath` (可选): 输出PDF文件路径
33
- - `template` (可选): PDF模板 (default/academic/modern)
34
- - `paperFormat` (可选): 页面格式 (a4/a3/a5/letter/legal/tabloid)
35
- - `paperOrientation` (可选): 页面方向 (portrait/landscape)
36
- - `watermark` (可选): 水印设置
37
- - `enableSyntaxHighlight` (可选): 启用语法高亮
38
- - `enableMermaid` (可选): 启用Mermaid图表
39
-
40
- ### 2. `convert_to_word` - Word转换
41
- 将Markdown内容或文件转换为Word文档,特别优化了代码块显示。
42
-
43
- **参数:**
44
- - `markdown` (必填): Markdown内容或.md文件路径
45
- - `outputPath` (可选): 输出Word文件路径
46
- - `theme` (可选): 代码块主题 (default/github/dark/minimal)
47
- - `addFooter` (可选): 是否添加页脚页码
48
- - `showLanguage` (可选): 是否显示代码块语言标识
49
-
50
- ### 3. `convert_batch` - 批量转换
51
- 批量转换多个Markdown文件。
52
-
53
- **参数:**
54
- - `files` (必填): Markdown文件路径列表
55
- - `format` (可选): 输出格式 (pdf/word/both)
56
- - `outputDir` (可选): 输出目录
57
- - `template` (可选): PDF模板
58
- - `theme` (可选): Word主题
59
-
60
- ### 4. `list_themes` - 列出主题
61
- 列出所有可用的Word代码块主题。
62
-
63
- ## 🎯 使用示例
64
-
65
- ### PDF转换示例
66
- ```javascript
67
- // 转换文件
68
- {
69
- "tool": "convert_to_pdf",
70
- "arguments": {
71
- "markdown": "/path/to/document.md",
72
- "outputPath": "/path/to/output.pdf",
73
- "template": "academic",
74
- "watermark": {
75
- "text": "Draft",
76
- "opacity": 0.1
77
- }
78
- }
79
- }
80
-
81
- // 转换内容
82
- {
83
- "tool": "convert_to_pdf",
84
- "arguments": {
85
- "markdown": "# 我的文档\n\n```python\nprint('Hello World')\n```",
86
- "template": "modern"
87
- }
88
- }
89
- ```
90
-
91
- ### Word转换示例
92
- ```javascript
93
- // 转换文件
94
- {
95
- "tool": "convert_to_word",
96
- "arguments": {
97
- "markdown": "/path/to/document.md",
98
- "outputPath": "/path/to/output.docx",
99
- "theme": "github",
100
- "showLanguage": true
101
- }
102
- }
103
-
104
- // 批量转换
105
- {
106
- "tool": "convert_batch",
107
- "arguments": {
108
- "files": ["/path/to/doc1.md", "/path/to/doc2.md"],
109
- "format": "both",
110
- "outputDir": "/path/to/output",
111
- "theme": "dark"
112
- }
113
- }
114
- ```
115
-
116
- ## 🎨 代码块主题
117
-
118
- ### Word文档主题
119
- - **default**: 经典灰色背景,适合日常使用
120
- - **github**: GitHub风格,清新简洁
121
- - **dark**: 暗色主题,护眼舒适
122
- - **minimal**: 极简风格,简约优雅
123
-
124
- 每个主题都经过精心调优,确保代码的可读性和美观性。
125
-
126
- ## ⚙️ 环境变量
127
-
128
- - `OUTPUT_DIR`: 默认输出目录 (默认: 用户主目录)
129
- - `MAX_CONCURRENT`: 最大并发数 (默认: 2)
130
- - `MAX_BROWSERS`: 最大浏览器实例数 (默认: 3)
131
- - `DISABLE_CACHE`: 禁用缓存 (设置为 'true' 禁用)
132
-
133
- ## 📁 项目结构
134
-
135
- ```
136
- src/
137
- ├── core/ # 核心转换器
138
- ├── BaseConverter.ts # 抽象基类
139
- ├── PDFConverter.ts # PDF转换器
140
- └── WordConverter.ts # Word转换器
141
- ├── config/ # 配置文件
142
- │ └── word.ts # Word样式配置
143
- ├── templates/ # 模板资源
144
- │ ├── pdf/ # PDF模板
145
- │ └── word/ # Word模板
146
- ├── types/ # 类型定义
147
- └── index.ts # MCP服务器入口
148
- ```
149
-
150
- ## 🔧 开发
151
-
152
- ### 安装依赖
153
- ```bash
154
- npm install
155
- ```
156
-
157
- ### 构建项目
158
- ```bash
159
- npm run build
160
- ```
161
-
162
- ### 运行服务器
163
- ```bash
164
- npm start
165
- ```
166
-
167
- ### 开发模式
168
- ```bash
169
- npm run dev
170
- ```
171
-
172
- ## 📄 技术栈
173
-
174
- - **TypeScript**: 类型安全的JavaScript超集
175
- - **MCP SDK**: Model Context Protocol 软件开发包
176
- - **Puppeteer**: PDF生成和页面渲染
177
- - **docx**: Word文档生成库
178
- - **Remarkable**: Markdown解析器
179
-
180
- ## 🌟 亮点功能
181
-
182
- ### 1. 完美的代码块显示
183
- 基于原md-to-word-mcp项目的成功实现,每一行代码都作为独立段落处理,确保:
184
- - 保持原有缩进结构
185
- - 支持多种编程语言
186
- - 语法高亮效果
187
- - 边框和背景美化
188
-
189
- ### 2. 智能缓存机制
190
- - **文件缓存**: 转换结果持久化存储
191
- - **内存缓存**: HTML渲染结果临时缓存
192
- - **自动清理**: 过期缓存自动清理
193
- - **缓存键优化**: 基于内容和配置生成唯一键
194
-
195
- ### 3. 资源优化管理
196
- - **浏览器池**: 复用Puppeteer实例
197
- - **并发控制**: 防止资源过度使用
198
- - **优雅关闭**: 确保资源正确释放
199
-
200
- ## 🤝 贡献
201
-
202
- 欢迎提交Issue和Pull Request!
203
-
204
- ## 📜 许可证
205
-
206
- MIT License
207
-
208
- ---
209
-
210
- **本项目融合了以下优秀项目的精华:**
211
- - 原 `enhanced-markdown2pdf-mcp` 的高性能PDF转换能力
212
- - 原 `md-to-word-mcp` 的优化Word代码块显示技术
213
-
214
- 通过统一架构设计,为用户提供一站式Markdown文档转换解决方案。
1
+ # 统一Markdown转换MCP服务器
2
+
3
+ [![TypeScript](https://img.shields.io/badge/TypeScript-5.3-blue.svg)](https://www.typescriptlang.org/)
4
+ [![Node.js](https://img.shields.io/badge/Node.js-18+-green.svg)](https://nodejs.org/)
5
+ [![MCP](https://img.shields.io/badge/MCP-1.0-orange.svg)](https://modelcontextprotocol.io/)
6
+
7
+ 一个功能强大的MCP (Model Context Protocol) 服务器,支持将Markdown文档转换为PDF和Word格式。**特别优化了代码块显示效果**,确保在转换后的文档中代码的完美呈现。
8
+
9
+ ## ✨ 主要特性
10
+
11
+ ### 🔄 双格式支持
12
+ - **PDF转换**: 高质量PDF生成,支持模板、水印、语法高亮等高级功能
13
+ - **Word转换**: 专业级Word文档生成,**特别优化代码块显示效果**
14
+
15
+ ### 🎨 丰富的自定义选项
16
+ - **PDF样式**: 内置经过优化的默认模板
17
+ - **Word主题**: default, github, dark, minimal 四种代码块主题
18
+ - **自定义样式**: 字体、颜色、间距等完全可定制
19
+
20
+ ### ⚡ 性能优化
21
+ - **智能缓存**: 文件系统 + 内存双重缓存机制
22
+ - **并发控制**: 资源池管理,支持批量转换
23
+ - **增量处理**: 避免重复转换,提高效率
24
+
25
+ ## 🛠️ 可用工具
26
+
27
+ ### 1. `convert_to_pdf` - PDF转换
28
+ 将Markdown内容或文件转换为PDF文件。
29
+
30
+ **参数:**
31
+ - `markdown` (必填): Markdown内容或.md文件路径
32
+ - `outputPath` (可选): 输出PDF文件路径
33
+ - `paperFormat` (可选): 页面格式 (a4/a3/a5/letter/legal/tabloid)
34
+ - `paperOrientation` (可选): 页面方向 (portrait/landscape)
35
+ - `watermark` (可选): 水印设置
36
+ - `enableSyntaxHighlight` (可选): 启用语法高亮
37
+ - `enableMermaid` (可选): 启用Mermaid图表
38
+
39
+ ### 2. `convert_to_word` - Word转换
40
+ 将Markdown内容或文件转换为Word文档,特别优化了代码块显示。
41
+
42
+ **参数:**
43
+ - `markdown` (必填): Markdown内容或.md文件路径
44
+ - `outputPath` (可选): 输出Word文件路径
45
+ - `theme` (可选): 代码块主题 (default/github/dark/minimal)
46
+ - `addFooter` (可选): 是否添加页脚页码
47
+ - `showLanguage` (可选): 是否显示代码块语言标识
48
+
49
+ ### 3. `convert_batch` - 批量转换
50
+ 批量转换多个Markdown文件。
51
+
52
+ **参数:**
53
+ - `files` (必填): Markdown文件路径列表
54
+ - `format` (可选): 输出格式 (pdf/word/both)
55
+ - `outputDir` (可选): 输出目录
56
+ - `theme` (可选): Word主题
57
+
58
+ ### 4. `list_themes` - 列出主题
59
+ 列出所有可用的Word代码块主题。
60
+
61
+ ## 🎯 使用示例
62
+
63
+ ### PDF转换示例
64
+ ```javascript
65
+ // 转换文件
66
+ {
67
+ "tool": "convert_to_pdf",
68
+ "arguments": {
69
+ "markdown": "/path/to/document.md",
70
+ "outputPath": "/path/to/output.pdf",
71
+ "watermark": {
72
+ "text": "Draft",
73
+ "opacity": 0.1
74
+ }
75
+ }
76
+ }
77
+
78
+ // 转换内容
79
+ {
80
+ "tool": "convert_to_pdf",
81
+ "arguments": {
82
+ "markdown": "# 我的文档\n\n```python\nprint('Hello World')\n```"
83
+ }
84
+ }
85
+ ```
86
+
87
+ ### Word转换示例
88
+ ```javascript
89
+ // 转换文件
90
+ {
91
+ "tool": "convert_to_word",
92
+ "arguments": {
93
+ "markdown": "/path/to/document.md",
94
+ "outputPath": "/path/to/output.docx",
95
+ "theme": "github",
96
+ "showLanguage": true
97
+ }
98
+ }
99
+
100
+ // 批量转换
101
+ {
102
+ "tool": "convert_batch",
103
+ "arguments": {
104
+ "files": ["/path/to/doc1.md", "/path/to/doc2.md"],
105
+ "format": "both",
106
+ "outputDir": "/path/to/output",
107
+ "theme": "dark"
108
+ }
109
+ }
110
+ ```
111
+
112
+ ## 🎨 代码块主题
113
+
114
+ ### Word文档主题
115
+ - **default**: 经典灰色背景,适合日常使用
116
+ - **github**: GitHub风格,清新简洁
117
+ - **dark**: 暗色主题,护眼舒适
118
+ - **minimal**: 极简风格,简约优雅
119
+
120
+ 每个主题都经过精心调优,确保代码的可读性和美观性。
121
+
122
+ ## ⚙️ 环境变量
123
+
124
+ - `OUTPUT_DIR`: 默认输出目录 (默认: 用户主目录)
125
+ - `MAX_CONCURRENT`: 最大并发数 (默认: 2)
126
+ - `MAX_BROWSERS`: 最大浏览器实例数 (默认: 3)
127
+ - `DISABLE_CACHE`: 禁用缓存 (设置为 'true' 禁用)
128
+
129
+ ## 📁 项目结构
130
+
131
+ ```
132
+ src/
133
+ ├── core/ # 核心转换器
134
+ │ ├── BaseConverter.ts # 抽象基类
135
+ │ ├── PDFConverter.ts # PDF转换器
136
+ │ └── WordConverter.ts # Word转换器
137
+ ├── config/ # 配置文件
138
+ └── word.ts # Word样式配置
139
+ ├── templates/ # 模板资源
140
+ ├── pdf/ # PDF模板
141
+ │ └── word/ # Word模板
142
+ ├── types/ # 类型定义
143
+ └── index.ts # MCP服务器入口
144
+ ```
145
+
146
+ ## 🔧 开发
147
+
148
+ ### 安装依赖
149
+ ```bash
150
+ npm install
151
+ ```
152
+
153
+ ### 构建项目
154
+ ```bash
155
+ npm run build
156
+ ```
157
+
158
+ ### 运行服务器
159
+ ```bash
160
+ npm start
161
+ ```
162
+
163
+ ### 开发模式
164
+ ```bash
165
+ npm run dev
166
+ ```
167
+
168
+ ## 📄 技术栈
169
+
170
+ - **TypeScript**: 类型安全的JavaScript超集
171
+ - **MCP SDK**: Model Context Protocol 软件开发包
172
+ - **Puppeteer**: PDF生成和页面渲染
173
+ - **docx**: Word文档生成库
174
+ - **Remarkable**: Markdown解析器
175
+
176
+ ## 🌟 亮点功能
177
+
178
+ ### 1. 完美的代码块显示
179
+ 基于原md-to-word-mcp项目的成功实现,每一行代码都作为独立段落处理,确保:
180
+ - 保持原有缩进结构
181
+ - 支持多种编程语言
182
+ - 语法高亮效果
183
+ - 边框和背景美化
184
+
185
+ ### 2. 智能缓存机制
186
+ - **文件缓存**: 转换结果持久化存储
187
+ - **内存缓存**: HTML渲染结果临时缓存
188
+ - **自动清理**: 过期缓存自动清理
189
+ - **缓存键优化**: 基于内容和配置生成唯一键
190
+
191
+ ### 3. 资源优化管理
192
+ - **浏览器池**: 复用Puppeteer实例
193
+ - **并发控制**: 防止资源过度使用
194
+ - **优雅关闭**: 确保资源正确释放
195
+
196
+ ## 🤝 贡献
197
+
198
+ 欢迎提交Issue和Pull Request!
199
+
200
+ ## 📜 许可证
201
+
202
+ MIT License
203
+
204
+ ---
205
+
206
+ **本项目融合了以下优秀项目的精华:**
207
+ - 原 `enhanced-markdown2pdf-mcp` 的高性能PDF转换能力
208
+ - 原 `md-to-word-mcp` 的优化Word代码块显示技术
209
+
210
+ 通过统一架构设计,为用户提供一站式Markdown文档转换解决方案。
@@ -76,15 +76,15 @@ export class MarkdownRenderer {
76
76
  const info = token.info ? token.info.trim() : '';
77
77
  const langName = info.split(/\s+/g)[0];
78
78
  if (langName === 'mermaid' && this.config.mermaid) {
79
- return `<div class="mermaid-container">
80
- <div class="mermaid" data-processed="false">${token.content}</div>
79
+ return `<div class="mermaid-container">
80
+ <div class="mermaid" data-processed="false">${token.content}</div>
81
81
  </div>`;
82
82
  }
83
83
  const highlighted = this.highlightCode(token.content, langName);
84
84
  const langClass = langName ? ` class="language-${langName}"` : '';
85
- return `<div class="code-block-container">
86
- <pre><code${langClass}>${highlighted}</code></pre>
87
- ${langName ? `<div class="code-language">${langName}</div>` : ''}
85
+ return `<div class="code-block-container">
86
+ <pre><code${langClass}>${highlighted}</code></pre>
87
+ ${langName ? `<div class="code-language">${langName}</div>` : ''}
88
88
  </div>`;
89
89
  };
90
90
  }