Skip to content

Commit f7e50a8

Browse files
committed
docs: 更新README文档并添加演示视频
- 在中文和英文README中添加演示视频部分 - 更新核心技术栈和依赖库信息 - 改进架构图描述
1 parent bc18b7f commit f7e50a8

File tree

2 files changed

+61
-23
lines changed

2 files changed

+61
-23
lines changed

README.md

Lines changed: 31 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,18 @@
88

99
> **Document Operations MCP Server** - A universal MCP server for document processing, conversion, and automation. Handle PDF, DOCX, HTML, Markdown, and more through a unified API and toolset.
1010
11+
## Demo
12+
13+
### Video
14+
15+
<https://github-production-user-asset-6210df.s3.amazonaws.com/83206877/478999982-463aba05-bf7e-4d18-a828-f9898c743787.mp4?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=AKIAVCODYLSA53PQK4ZA%2F20250818%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250818T104249Z&X-Amz-Expires=300&X-Amz-Signature=cea37a894e1442764e7aa165c7c40e080e4935435c159327af7f882eadbad128&X-Amz-SignedHeaders=host>
16+
17+
In this demo, we showcase how to:
18+
19+
- Configure doc-ops-mcp in MCP clients
20+
- Convert Markdown documents to HTML format
21+
- Convert the resulting HTML to PDF documents
22+
1123
## Table of Contents
1224

1325
1. [Quick Start](#1-quick-start)
@@ -22,7 +34,7 @@
2234
10. [Troubleshooting](#10-troubleshooting)
2335
11. [Contributing](#11-contributing)
2436

25-
## 1. Getting Started
37+
## 1. Quick Start
2638

2739
First, add the Document Operations MCP server to your MCP client.
2840

@@ -185,13 +197,17 @@ Document Operations MCP Server adopts a pure JavaScript architecture design, pro
185197
┌───────────────────────────┴─────────────────────────────────┐
186198
│ Core Dependencies Layer │
187199
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
188-
│ │ pdf-lib │ │ mammoth │ │ marked │ │
189-
│ │ (PDF Tools) │ │(DOCX Tools) │ │ (Markdown) │ │
200+
│ │ pdf-lib │ │word-extractor│ │ marked │ │
201+
│ │ (PDF Tools) │ │(DOCX Reader)│ │ (Markdown) │ │
190202
│ └─────────────┘ └─────────────┘ └─────────────┘ │
191203
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
192-
│ │ cheerio │ │ turndown │ │ docx │ │
193-
│ │(HTML Parser)│ │(HTML to MD) │ │(DOCX Gen.) │ │
204+
│ │ cheerio │ │ jszip │ │ docx │ │
205+
│ │(HTML Parser)│ │(ZIP Handler)│ │(DOCX Gen.) │ │
194206
│ └─────────────┘ └─────────────┘ └─────────────┘ │
207+
│ ┌─────────────┐ ┌─────────────┐ │
208+
│ │ xml2js │ │Custom OOXML │ │
209+
│ │(XML Parser) │ │ Parser │ │
210+
│ └─────────────┘ └─────────────┘ │
195211
└─────────────────────────────────────────────────────────────┘
196212
```
197213

@@ -390,11 +406,13 @@ Convert HTML to Markdown.
390406

391407
### Core Technology Stack
392408
- **pdf-lib** - PDF operations and enhancement
393-
- **mammoth** - DOCX document processing
409+
- **word-extractor** - DOCX document text extraction
394410
- **marked** - Markdown parsing and rendering
395411
- **cheerio** - HTML parsing and manipulation
396-
- **turndown** - HTML to Markdown conversion
397412
- **docx** - DOCX document generation
413+
- **jszip** - ZIP file processing
414+
- **xml2js** - XML parsing and conversion
415+
- **Custom OOXML Parser** - Advanced DOCX style preservation
398416

399417
### Installation
400418
```bash
@@ -427,11 +445,12 @@ bun add -g doc-ops-mcp
427445
| Library | Version | License | Purpose |
428446
|---------|---------|---------|----------|
429447
| **pdf-lib** | ^1.17.1 | MIT | PDF document manipulation |
430-
| **mammoth** | ^1.6.0 | BSD-2-Clause | DOCX parsing and conversion |
431-
| **marked** | ^9.1.6 | MIT | Markdown parsing and rendering |
432-
| **exceljs** | ^4.4.0 | MIT | Excel file processing |
433-
| **jsdom** | ^23.0.1 | MIT | HTML DOM manipulation |
434-
| **turndown** | ^7.1.2 | MIT | HTML to Markdown conversion |
448+
| **word-extractor** | ^1.0.4 | MIT | DOCX document text extraction |
449+
| **marked** | ^15.0.12 | MIT | Markdown parsing and rendering |
450+
| **cheerio** | ^1.0.0-rc.12 | MIT | HTML parsing and manipulation |
451+
| **docx** | ^9.5.1 | Apache-2.0 | DOCX document generation |
452+
| **jszip** | ^3.10.1 | MIT | ZIP file processing |
453+
| **xml2js** | ^0.6.2 | MIT | XML parsing and conversion |
435454

436455
### License Compatibility
437456
-**Commercial Use**: All dependencies support commercial use

README_zh.md

Lines changed: 30 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,18 @@
2222
10. [故障排除](#10-故障排除)
2323
11. [贡献指南](#11-贡献指南)
2424

25+
## 演示
26+
27+
### 视频
28+
29+
<https://github.com/user-attachments/assets/demo.mov>
30+
31+
在这个演示中,我们展示了如何:
32+
33+
- 在 MCP 客户端中配置 doc-ops-mcp
34+
- 将 Markdown 文档转换为 HTML 格式
35+
- 将转换后的 HTML 转换为 PDF 文档
36+
2537
## 1. 快速开始
2638

2739
首先,将 Document Operations MCP 服务器添加到您的 MCP 客户端。
@@ -185,13 +197,17 @@ Document Operations MCP Server 采用纯 JavaScript 架构设计,提供完整
185197
┌───────────────────────────┴─────────────────────────────────┐
186198
│ 核心依赖层 │
187199
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
188-
│ │ pdf-lib │ │ mammoth │ │ marked │ │
189-
│ │ (PDF处理) │ │ (DOCX处理) │ │ (Markdown) │ │
200+
│ │ pdf-lib │ │word-extractor│ │ marked │ │
201+
│ │ (PDF处理) │ │ (DOCX读取) │ │ (Markdown) │ │
190202
│ └─────────────┘ └─────────────┘ └─────────────┘ │
191203
│ ┌─────────────┐ ┌─────────────┐ ┌─────────────┐ │
192-
│ │ cheerio │ │ turndown │ │ docx │ │
193-
│ │ (HTML解析) │ │ (HTML转MD) │ │ (DOCX生成) │ │
204+
│ │ cheerio │ │ jszip │ │ docx │ │
205+
│ │ (HTML解析) │ │ (ZIP处理) │ │ (DOCX生成) │ │
194206
│ └─────────────┘ └─────────────┘ └─────────────┘ │
207+
│ ┌─────────────┐ ┌─────────────┐ │
208+
│ │ xml2js │ │ 自定义OOXML │ │
209+
│ │ (XML解析) │ │ 解析器 │ │
210+
│ └─────────────┘ └─────────────┘ │
195211
└─────────────────────────────────────────────────────────────┘
196212
```
197213

@@ -392,11 +408,13 @@ HTML转Markdown。
392408

393409
### 核心技术栈
394410
- **pdf-lib** - PDF操作和增强
395-
- **mammoth** - DOCX文档处理
411+
- **word-extractor** - DOCX文档文本提取
396412
- **marked** - Markdown解析和渲染
397413
- **cheerio** - HTML解析和操作
398-
- **turndown** - HTML到Markdown转换
399414
- **docx** - DOCX文档生成
415+
- **jszip** - ZIP文件处理
416+
- **xml2js** - XML解析和转换
417+
- **自定义OOXML解析器** - 高级DOCX样式保留
400418

401419
### 安装
402420
```bash
@@ -429,11 +447,12 @@ bun add -g doc-ops-mcp
429447
| 依赖库 | 版本 | 协议 | 用途 |
430448
|--------|------|------|------|
431449
| **pdf-lib** | ^1.17.1 | MIT | PDF 文档操作和处理 |
432-
| **mammoth** | ^1.6.0 | BSD-2-Clause | DOCX 文档解析和转换 |
433-
| **marked** | ^9.1.6 | MIT | Markdown 解析和渲染 |
434-
| **exceljs** | ^4.4.0 | MIT | Excel 文件处理 |
435-
| **jsdom** | ^23.0.1 | MIT | HTML DOM 操作 |
436-
| **turndown** | ^7.1.2 | MIT | HTML 转 Markdown |
450+
| **word-extractor** | ^1.0.4 | MIT | DOCX 文档文本提取 |
451+
| **marked** | ^15.0.12 | MIT | Markdown 解析和渲染 |
452+
| **cheerio** | ^1.0.0-rc.12 | MIT | HTML 解析和操作 |
453+
| **docx** | ^9.5.1 | Apache-2.0 | DOCX 文档生成 |
454+
| **jszip** | ^3.10.1 | MIT | ZIP 文件处理 |
455+
| **xml2js** | ^0.6.2 | MIT | XML 解析和转换 |
437456

438457
### 协议兼容性
439458
-**商业使用**:所有依赖均支持商业使用

0 commit comments

Comments
 (0)