idocking/go-pandoc

idocking/go-pandoc镜像说明

镜像概述

idocking/go-pandoc镜像将Pandoc工具封装为HTTP服务，提供文档格式转换能力，支持多种数据输入方式和模板渲染，方便集成到各类应用中实现自动化文档处理。

核心功能

1. 格式转换：支持Markdown转PDF、HTML等多种格式，可配置Pandoc参数（如字体、页面边距）。
2. 数据输入：提供Data（Base64编码）和HTTP（远程URL）两种数据获取方式。
3. 模板渲染：内置默认、render-html、binary等模板，支持自定义模板生成不同响应格式（如直接渲染HTML或下载二进制文件）。
4. 附加特性：支持CORS跨域、Gzip压缩、优雅停机等。

使用场景

• 自动化生成PDF报告的业务系统。
• 应用集成文档转换功能，无需本地部署Pandoc。
• 批量处理Markdown文档生成统一格式的输出。

配置说明

通过app.conf配置服务和Pandoc参数，关键配置项：

• service：HTTP端口、CORS规则、Gzip开关、模板路径。
• pandoc：安全目录、数据获取驱动（Data/HTTP）、日志级别。

配置示例：

json
{
  "service": {
    "path": "/v1",
    "cors": {"allowed-origins": ["*"]},
    "gzip-enabled": true,
    "http": {"address": ":8080", "enabled": true},
    "templates": {
      "render-html": {"template": "templates/render_html.tmpl"},
      "binary": {"template": "templates/binary.tmpl"}
    }
  },
  "pandoc": {
    "safe-dir": "/app",
    "fetchers": {
      "http": {"driver": "http", "options": {}},
      "data": {"driver": "data", "options": {}}
    }
  }
}

部署示例

Docker Run

bash
docker pull idocking/go-pandoc:latest
docker run -it -d -p 8080:8080 idocking/go-pandoc:latest ./go-pandoc run

Docker Compose

bash
docker-compose up -d

部署后通过http://IP:8080访问服务（OSX需用docker-machine ip获取容器IP）。

API使用

Markdown转PDF示例

bash
curl -X POST \
  http://IP:8080/v1/convert \
  -H 'accept-encoding: gzip' \
  -H 'content-type: application/json' \
  -d '{
    "fetcher": {"name": "data", "params": {"data": "IyMjIEhlbGxvCgo+IEdvLVBhbmRvYw=="}},
    "converter": {
      "from": "markdown", "to": "pdf", "standalone": true,
      "variable": {"CJKmainfont": "Source Han Sans SC", "geometry:margin": "1cm"}
    },
    "template": "binary"
}' --compressed -o test.pdf

模板说明

• binary：直接生成二进制文件（如PDF）。
• render-html：生成包含Base64内容的HTML页面，可直接在浏览器渲染。

自定义Fetcher

扩展数据获取方式：

1. 实现Fetcher接口：

go
type Fetcher interface { Fetch(FetchParams) ([]byte, error) }

2. 注册驱动：

go
func init() { fetcher.RegisterFetcher("custom", NewCustomFetcher) }

3. 导入驱动并重新构建镜像。