PDF3MD快速入门指南：PDF与Markdown互转工具部署教程

项目概述

PDF3MD是一款开源的文档格式转换工具，专注于实现PDF与Markdown格式之间的双向转换。该工具采用前后端分离架构，支持通过Docker容器化部署，为开发者和普通用户提供了便捷的文档处理解决方案。

环境准备

在开始部署前，请确保您的系统满足以下基础条件：

1. 操作系统：支持Linux、macOS或Windows（建议使用Linux/macOS获得最佳体验）
2. 硬件要求：至少2GB可用内存，5GB磁盘空间
3. 软件依赖：
   • Docker方式：需安装Docker Engine 20.10+和Docker Compose 2.0+
   • 手动部署：需Python 3.8+和Node.js 16+

Docker容器化部署（推荐方案）

1. 创建项目目录结构

首先建立一个清晰的项目目录结构，便于后续管理：

mkdir -p pdf3md-app/{config,data,temp} && cd pdf3md-app

这种结构将配置文件、持久化数据和临时文件分开存放，符合生产环境最佳实践。

2. 编写Docker Compose配置

创建docker-compose.yml文件，内容如下：

version: '3.8'

services:
  backend:
    image: learnedmachine/pdf3md-backend:latest
    container_name: pdf3md-backend
    ports:
      - "6201:6201"
    environment:
      - PYTHONUNBUFFERED=1
      - FLASK_ENV=production
    volumes:
      - ./data:/app/data  # 持久化数据目录
      - ./temp:/app/temp  # 临时文件目录
    restart: unless-stopped
    healthcheck:
      test: ["CMD", "curl", "-f", "http://localhost:6201/health"]
      interval: 30s
      timeout: 10s
      retries: 3

  frontend:
    image: learnedmachine/pdf3md-frontend:latest
    container_name: pdf3md-frontend
    ports:
      - "3000:3000"
    depends_on:
      backend:
        condition: service_healthy
    restart: unless-stopped

关键配置说明：

• 使用unless-stopped重启策略确保服务异常退出后自动恢复
• 健康检查机制保障服务可用性
• 合理的卷挂载实现数据持久化

3. 启动服务

执行以下命令启动服务：

docker-compose up -d

首次运行时会自动拉取所需的Docker镜像，整个过程可能需要几分钟时间，取决于您的网络状况。

4. 验证服务状态

检查服务是否正常运行：

docker-compose ps

正常状态下应该看到两个服务的状态均为"healthy"。

开发模式部署

对于需要修改源码的开发者，可以使用开发模式部署：

1. 获取源代码

git clone pdf3md源码仓库 && cd pdf3md

2. 启动开发环境

docker-compose -f docker-compose.dev.yml up --build

开发模式特点：

• 启用代码热重载（HMR）
• 前端开发服务器运行在5173端口
• 后端开启调试模式
• 源码目录实时映射到容器内

手动部署方案

后端服务部署

1. 安装Python依赖：

pip install -r requirements.txt

2. 配置环境变量：

export FLASK_APP=app.py
export FLASK_ENV=development

3. 启动服务：

flask run --port 6201

前端服务部署

1. 安装Node.js依赖：

npm install

2. 启动开发服务器：

npm run dev

基本使用指南

PDF转Markdown

1. 访问前端界面（默认http://localhost:3000）
2. 拖放PDF文件到上传区域或点击选择文件
3. 等待转换完成
4. 复制生成的Markdown文本或下载为.md文件

Markdown转Word

1. 切换到"MD → Word"模式
2. 粘贴Markdown内容或上传.md文件
3. 点击"下载为Word"按钮
4. 获取生成的.docx文档

常见问题排查

1. 端口冲突：如果默认端口被占用，修改docker-compose.yml中的端口映射
2. 权限问题：确保Docker有足够的权限访问挂载目录
3. 转换失败：检查PDF文件是否受密码保护或损坏
4. 性能优化：大文件处理时，建议增加Docker内存限制

进阶配置

自定义域名

通过修改前端环境变量可实现自定义域名：

environment:
  - VITE_API_BASE_URL=https://api.yourdomain.com

性能调优

对于高负载场景，可以调整后端工作线程数：

command: ["gunicorn", "-w", "4", "-b", ":6201", "app:app"]

结语

PDF3MD通过容器化技术简化了文档格式转换服务的部署过程，无论是用于个人文档处理还是集成到企业工作流中，都能提供稳定可靠的服务。建议生产环境使用Docker部署方案，开发调试时可采用开发模式获得更好的开发体验。