PandocWordTemplate

KO | EN

gitlite — search

#python #javascript #typescript #react #devops #docker #unity #security #deep-learning #reactjs #api #android

PandocWordTemplate

★ 66 Open GitHub ↗

My personal word template for pandoc

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# 自用 Pandoc Word 模板

本模板使用 [pandoc](https://pandoc.org/) 将 markdown 文档转换为 `.docx` 文件。

![overview](https://raw.githubusercontent.com/Thysrael/PandocWordTemplate/main/example/overview.png)

## 用法

1. 下载 `pandoc`
2. 将本仓库内的 `template.docx` 下载到本地
3. 执行如下命令，其中 `exmaple.md` 是需要转换成 word 的 md 文件，`template.docx` 是刚下载的文件：

```shell
pandoc ./example.md \
    --reference-doc=./template.docx \
    --shift-heading-level-by=-1 \
    -t docx+native_numbering \
    -o example.docx
```

4. `example.docx` 就是转换好的文件。

上述方式可以完成大部分 markdown 样式的转换，已经可以覆盖大部分 word 文档的需求。但是没有办法完成“参考文献引用”相关的功能。

“文献引用”相关功能依赖仓库内的 `bib.bib` 提供文献信息，`ieee.csl` 提供文献格式，具体可以参考 `example.md` 和 `transfer.sh` 中的内容。

## 配置知识

我虽然承认 `pandoc` 是一个非常强大的工具，但是配置起来实在是太麻烦了。
我个人的使用思路是 `pandoc` 完成大部分的转换工作，对于细节处手动微调。

### Markdown 标题层次

使用 `--shift-heading-level-by=-1` 可以使得 markdown 文档中的 `Level1 heading` 变成 `title`，让 `Level2 heading` 变成 `Level1 heading` 。

### 图片 Caption

Caption 的样式由 `Image Caption` 和 `Table Caption` 两个 `reference.docx` 样式所决定。

要开启 caption 的生成，需要先指定参数 `-t docx+native_numbering`。

如果希望使用中文的 caption，可以使用 `-M lang=zh-CN` 参数，但是此时需要在 pandoc 的 `User data directory` 创建 `translations/zh.yaml` 文件，其中内容为：

```yaml
Figure: 图
Table: 表
Contents: 目录
```

`User data directory` 可以用如下命令查看：

```shell
pandoc --version
```

### Table Style

表格的格式可以通过名为 `Table` 的样式进行调整，但是只能在 Word 中调整，而不能在 WPS 中调整。对于引用块（`Text Block`）的调整也是类似。

但是 Word 又很难调整这些，经常与内置样式冲突，所以我没有仔细折腾。

### 文献引用

使用如下参数，就可以根据 `bib.bib` 中的内容生成参考文献并指定格式为 `ieee`：

```shell
--citeproc --bibliography bib.bib --csl=http://www.zotero.org/styles/ieee
```

### 交叉引用

对于图片和表格的交叉引用，需要使用插件 `pandoc-crossref`，我尝试了一下，感觉效果不好（尤其是中文效果）。就没有继续深究。

## 参考资料

- [使用 Markdown 搭配 Pandoc 撰写学术论文的详细指南](https://zhuanlan.zhihu.com/p/395193554)
- [Pandoc 从入门到精通，你也可以学会这一个文本转换利器](https://sspai.com/post/77206)

PandocWordTemplate

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README