使用md文件生成docx

需求说明

需要将markdown格式的文件生成docx，比较特殊的是需要将无序列表和有序列表转化为大写字母的有序列表。

解决方案

Google之后，有了以下两种解决方案：

1. 使用pandoc，直接将md转化为docx
2. 解析md文件，使用officegen生成docx文件

最终使用方案一解决了需求，生成docx文件，两种方案都可以很简单的实现，麻烦的是将无序列表和有序列表转化为大写字母的有序列表，现在是通过pandoc的filter来实现的。

1. 安装pandoc，windows直接下载安装文件安装，设置环境变量；linux使用命令sudo apt-get install pandoc安装。
2. 安装过滤器，过滤器可以是任意语言编写，其主要作用是处理json文件，pandoc在写入文件之后，输出文件之前都会先将转化为json，过滤器就是在这个过程之中处理json。我使用的过滤器是pandoc-filter-node。
3. 执行命令pandoc -s [*.md] --filter [filter] -f [format] -o [*.docx]，即可生成。
4. 在项目中使用，使用child_process执行命令，代码child_process.execSync(\pandoc --filter ./scripts/filter.js -f markdown_github -o ${dirDocx + file}`, {input: content})`，content是输入内容。

// 过滤文件
var pandoc = require('pandoc-filter');

function action (type, value, format, meta) {
  if (type === 'BulletList') {
    return pandoc.OrderedList([
      1,
      {
        "t": "UpperAlpha"
      },
      {
        "t": "Period"
      }
    ], value)
  }
}

pandoc.stdio(action)

过程探究

1

最终的解决方案方案并不是很复杂，但得出方案的过程就比较曲折。
首先尝试第一个方案，先查看pandoc文档，了解到pandoc安装过程，知道了pandoc命令的作用，这时已经可以生成docx文档，接下来是修改docx样式，使用命令参数--reference-docx=FILE，可以设置docx的样式，测试后发现，对于标题、文字样式都是有效的，但是列表样式无法生效。

2

于是我开始尝试使用第二个方案，生成docx文档简单，关键是将无序列表转化为大写字符的有序列表，使用officegen可以设置有序或无序，但是无法设置为大写字母的有序列表，阅读officegen源码，发现officegen生成docx文件的原理是将一系列XML文件添加进docx中，再次谷歌，document.xml保存信息，styles.xml保存样式，numbering.xml保存列表标题设置，这就是pandoc中设置docx对列表序号无效的原因。officegen列表相关生成代码没有看出头绪，所以准备采取替代方法，将无序列表转换为大写字母的有序列表，其实可以在读取md后，为无序列表添加大写字母，作为普通文本输出即可。采取这种方式，使用pandoc可以，继续使用officegen也可，而使用pandoc无需手动解析md，于是又回到pandoc的使用上。

3

再次阅读pandoc文档，发现了新的内容，pandoc关于脚本使用的说明，其中Text.Pandoc.Definition说明了json数据结构各个字段的意义。详细阅读后写出了最终的过滤方法，解决了全部需求。

结果分析

1

从项目完成的意义上，这次解决问题是失败的。完成这个功能浪费太多时间，拖慢了项目的整体进度，如果一开始就采用手动添加大写字母替代的方法，很快就能够解决问题，但是因为不采用最好的方法就感觉哪里不舒服的心理，没有第一时间采取这种方法。这种心理并不可取，特别是在完成项目时，这次最终完美解决还好，而很多时候并没有完美的解决方法，最终也只能退而求其次。项目进度最重要，研究原理，寻找更好的解决方法可以之后有时间再尝试。

2

从学习方法阅读文档的角度上，过于马虎了。官方文档阅读一部分后，就进行谷歌使用案例，然后根据案例进行实践，但其实很多时候案例只能告诉我们怎么解决问题，无法告诉我们为什么这样做可以解决问题，如果我们的需求与案例相同是可以很快解决，而一旦略有不同我们就束手无策了。而官方的文档更复杂，但是也更详细，如果谷歌解决不了我们的问题，我们可以溯本求源，在文档中求得答案，如果仔细阅读文档还没有答案就只好采取其他方案了。

3

虽然对于项目来说，浪费了不少时间，但是对于个人却在其中学习到不少知识。如docx文档的组成，以后碰到需要生成固定模板（如请假表、简历）的docx文件时，就可以通过替换修改document.xml的数据完成。所以多花时间多研究，对于提升自己的能力，拓展自己的知识面很有帮助。

参考文档：
使用 Pandoc Markdown 进行学术论文写作
docx组成文件介绍
docx xml 说明