Pandoc 学习使用指南

欢迎大家来到IT世界,在知识的湖畔探索吧!

目录

• Pandoc 简介
• 安装方法
• 基本用法
• 文件格式转换
• 格式化选项
• 模板使用
• 元数据
• 过滤器
• 高级功能
• 在 VSCode 中使用 Pandoc
• 常见问题解答
• 实用案例
• 参考资料

Pandoc 简介

Pandoc 是一个强大的文档转换工具，由 John MacFarlane 创建，使用 Haskell 语言编写。它被称为”文档转换的瑞士军刀”，能够在几乎所有主流文档格式之间进行转换。

主要特点

• 多格式支持：支持包括 Markdown、HTML、LaTeX、Word、EPUB、PDF 等几十种格式
• 高度可定制：提供丰富的选项控制输出格式
• 元数据处理：支持 YAML 元数据块，便于添加文档属性
• 扩展语法：提供 Markdown 的多种扩展功能
• 模板系统：允许用户自定义输出模板
• 过滤器支持：通过过滤器增强转换功能

Pandoc 工作流程

欢迎大家来到IT世界,在知识的湖畔探索吧!

安装方法

Windows 安装

1. 访问官方网站 https://pandoc.org/installing.html 下载安装包
2. 运行下载的 MSI 安装文件
3. 验证安装：

• pandoc –version

macOS 安装

使用 Homebrew 安装：

Linux 安装

• Debian/Ubuntu：
• sudo apt-get update && sudo apt-get install pandoc
• CentOS/RHEL：
• sudo yum install pandoc
• Arch Linux：
• sudo pacman -S pandoc

基本用法

基本命令格式：

pandoc [选项] [输入文件] -o 输出文件

常用示例

• Markdown → HTML：
• pandoc input.md -o output.html
• Markdown → PDF（需 LaTeX）：
• pandoc input.md -o output.pdf
• Markdown → Word：
• pandoc input.md -o output.docx

文件格式转换

输入格式（部分）

输出格式（部分）

指定输入输出格式

pandoc -f markdown -t html input.md -o output.html

在 VSCode 中使用 Pandoc

导出 Markdown 为 Word 文档

方法一：命令行工具

1. 安装 Pandoc（参考安装方法）
2. 在 VSCode 终端执行：

• pandoc input.md -o output.docx

方法二：使用 vscode-pandoc 插件

1. 安装插件：在扩展市场搜索 vscode-pandoc
2. 配置 Pandoc 路径（设置 → pandoc.path）
3. 按 Ctrl+Shift+P → 输入 Pandoc: Export to Docx

方法三：使用模板

pandoc input.md –reference-doc=template.docx -o output.docx

配置 Markdown-preview-enhanced 插件

1. 安装 Pandoc 并配置环境变量
2. 设置插件参数：

• “markdown-preview-enhanced.pandocPath”: “/path/to/pandoc”,
  “markdown-preview-enhanced.pandocArguments”: [“–filter=pandoc-crossref”]

1. 在 Markdown 文件添加 YAML 前言：

• —
  output: word_document
  pandoc_args: [“–number-sections”]
  —

常见问题解答

Q: 转换 PDF 时出现错误

A: 确保已安装 LaTeX 发行版（如 TeX Live、MiKTeX）。示例安装命令：

# macOS
brew install basictex
# Linux
sudo apt-get install texlive-xetex

Q: 如何解决 Error: Output format needs to be specified？

A:

1. 在 Markdown 文件添加 YAML 前言：

• output: word_document

1. 或在命令行明确指定格式：

• pandoc input.md -t docx -o output.docx

实用案例

学术论文撰写

pandoc paper.md –citeproc –bibliography=refs.bib –template=ieee.tex -o paper.pdf

电子书制作

pandoc title.txt chapter*.md –toc –epub-cover-image=cover.jpg -o book.epub

幻灯片制作

参考资料

• Pandoc 官方网站
• Pandoc 用户手册
• Pandoc 模板库
• VSCode Pandoc 插件文档