山岚的运维笔记头像
14 天 Pandoc 文档转换实战 -- Pandoc 教程 01:文档转换是什么,装完跑第一条命令封面图

14 天 Pandoc 文档转换实战 -- Pandoc 教程 01:文档转换是什么,装完跑第一条命令

摘要:Markdown 写完,同事要 Word 版,你还要出带目录的 PDF 和一本电子书。一种格式排一次版,人得累趴。文档转换这摊事,Pandoc 一个命令行工具基本全包。这篇从 Pandoc 是什么聊起,把 winget 报「找不到与输入条件匹配的程序包」、pandoc --version 里那个 +lua 都拆开,再跑通第一条 Markdown 转 HTML 命令,连 -s 前后 13 行和 271 行的差距也一并看掉。

同事在群里甩来一句「这份发我 Word 版」,你手上只有写得好好的 README.md。
反常识的是,这活根本不用打开 Word,也不用一遍遍另存为。
可 winget install --source winget --exact --id JohnMacFarlane.Pandoc 敲下去,终端回你一句「找不到与输入条件匹配的程序包」。

Pandoc 官网首页,右上角写着 a universal document converter,左边一大片是可以互转的格式列表

Pandoc 是什么:一个命令行工具吃掉几十种格式

开头那张图是 https://pandoc.org 的首页。右上角挂着一行小字 a universal document converter,左边一大片格式列表,每一个 ↔ 都代表一个能互转的方向。界面朴素得有点过分,别被它骗了。

Pandoc 是开源的命令行文档转换工具,John MacFarlane 在 2006 年创建,用 Haskell 写。说人话:给它一种格式的文件,还你另一种格式的文件,中间不用你手工搬砖。

它能吃的格式,我第一次翻清单也愣了一下。轻量标记语言这边有 Markdown(多种方言)、CommonMark、GitHub Flavored Markdown、reStructuredText、AsciiDoc、Org-mode、Textile、MediaWiki、DokuWiki;网页相关是 HTML、XHTML、HTML5;排版系统 LaTeX、ConTeXt、Typst;办公文档 Word DOCX、OpenDocument ODT、PowerPoint PPTX、Excel XLSX;电子书 EPUB 2、EPUB 3、FictionBook;学术格式 JATS、TEI、DocBook、OPML、BibTeX、CSL JSON;数据格式 JSON(AST)、CSV、TSV;再往外还有 PDF(依赖外部引擎)、Man 手册、RTF、Roff。

PDF 那项先记个账,它后面会翻脸。就行。

讲道理,只要你手上有其中一种格式的内容,Pandoc 大概率能给你转成另一种。这么长一串名字背不下来也没关系,日常用得上的就那几个。

解析、AST、渲染:Pandoc 转换根本不是字符串替换

Pandoc 的转换不是拿字符串替换一遍糊弄过去。它中间垫了一层:AST,Abstract Syntax Tree,抽象语法树。

输入文件
   ↓ 解析(Reader)
抽象语法树(AST)
   ↓ 渲染(Writer)
输出文件

输入是 Markdown,由 Markdown Reader 解析成 AST;AST 是一份结构化的文档描述,标题、段落、列表、代码块都是里头的节点;要出 DOCX,再由 DOCX Writer 把 AST 渲染成 Word 文档。

这么绕一圈图什么?格式互转被拆开了:输入格式只管实现 Reader,输出格式只管实现 Writer,两边不用互相认识。语义结构留得住,不是把文字复制过去就完事。还能在 AST 上挂 Lua 过滤器做处理。说人话,Reader 负责读,Writer 负责写,AST 是那份谁都看得懂的中间稿。

输入经 Reader 解析成 AST,再由 Writer 渲染成输出文件的三段流程
这设计还漏了个便宜给我们:AST 能直接打印出来看。哪天你纳闷「我这行明明是标题,怎么转出来成了正文」,用 -t native 把 AST 打出来,Pandoc 到底把你的字认成了什么,一眼见底。第 13 章会拿它排查。

别急,多跑一次就清楚了。

一次写作多端输出:-o 后面换个后缀,交付物就换了

知道它怎么转,再说值不值得学。我的答案是值,理由不抽象,全是具体活儿。

一次写作,多端输出。Markdown 写一遍,HTML、PDF、DOCX、EPUB、PPTX 都能出,不用给每种格式重排版。我一开始也以为这得配一堆模板,结果并不,很多时候就是 -o 后面换个后缀的事。

格式互转是日常操作:Word → Markdown、HTML → Markdown、LaTeX → DOCX、EPUB → PDF,这些它都不打怵。命令行工具天生适合脚本和 CI,Makefile、GitHub Actions、Docker 里都能塞,批量转换不费劲。可定制那块靠模板系统控输出结构,Lua 过滤器改内容,自定义 CSS、LaTeX 模板、reference.docx 随你换。开源免费,Windows、macOS、Linux 全支持,社区一直有人维护。还有一层:很多静态博客、文档站点、电子书工具底层就在调 Pandoc,学会它等于把文档转换这套通用技能揣兜里。

光说没感觉,把活儿摆成一张表更直观。下面这张是原章给的场景清单,输入、输出、用途一一对上,看的时候顺手找找自己手头那份文件落在哪行。

场景 输入 输出 说明
技术博客 Markdown HTML 生成静态页面
交付文档 Markdown DOCX 发给同事或客户
打印文档 Markdown PDF 带目录、页码、页眉
电子书 Markdown EPUB 发布到 Kindle、多看
演示文稿 Markdown PPTX 用 Markdown 做 PPT
文档迁移 DOCX Markdown 把旧文档转成 Markdown
网页转换 HTML Markdown 抓取网页内容
学术论文 Markdown LaTeX/PDF 生成投稿版
简历 Markdown PDF 用模板

转载自 CSDN-专业IT技术社区

原文链接:https://blog.csdn.net/stgduser/article/details/170644221

文章来源转载

评论

评论列表

微信小程序
QQ小程序

关于作者

点赞数:0
关注数:0
粉丝:0
文章:0
关注标签:0
加入于:--