利用Git进行docx文档版本管理的简单方法

程序员文章站 2022-03-03 14:41:36

...

需求：
1）程序开发过程中，不同代码版本的管理
2）论文/技术文档（docx）写作过程中，不同文档版本的管理
3）最好能跨平台（win,mac）使用

解决方法

概要步骤：
1）安装与设置Git，创建版本库（repository）
2）安装Pandoc，配置Git以能管理Microsoft Word的docx文件。

Git是目前最棒的分布式版本控制软件，有很多非常实用的功能，比如：

跟踪文件的所有更改情况
快速回退到任意一个旧版本
多人协作同一文件而不会有版本冲突

Step1：安装与设置Git

到Git官网下载Git软件，下载后双击运行，选择安装目录后，一路默认确定即可。

安装完成后，打开Git Bash，设置使用当前设备的用户名和邮箱地址。可选择将该用户名和地址用于所有的Git仓库(即版本库，repository，被管理文件所在目录)，也可选择将该用户名和地址用于指定仓库。为方便，本文设置其用于所有仓库，即global属性:

git config --global user.name "Your Name"
git config --global user.email "[email protected]"

以上是针对win10系统的安装方法，对于Mac系统，则更为简单，在Mac终端输入git，若没有安装过git，则会弹出对话框，询问是否现在安装git，选择确定，软件会自动下载和安装。

Step 2: 创建Git版本库

如前所述，Git版本库又称为Git仓库，是所要管理的文件所在的目录。该目录下的所有文件都可以被Git管理。

在Git Bash下，创建一个Git版本库的方法如下：

cd /Your/Dictionary
mkdir YourRepositoryName
cd YourRepositoryName
git init

上述步骤分别进行的是，在你想建立版本库的目录下，新建一个你来命名的文件夹，进到该文件夹下后，利用git init命令将该文件夹目录变成Git版本库。

上述操作后，在该版本库目录下，会自动生成一个.git目录，用来跟踪管理版本库。

Step 3：安装Pandoc

为何要安装Pandoc?

原因是，Git通常适合¹对纯文本文件进行版本控制，docx文档则不是一个纯文本文件，所以需要第三方转化工具（比如Pandoc）,将docx转化为纯文本。

在Pandoc官网按个人习惯，选择下载.msi或.zip等不同方式的安装包文件。

下载后，双击运行，选择安装目录，点击安装即可。

Step 4：对`Git`进行`Pandoc`相关的配置

目的是，使Git能自动将docx文件转换成markdown，并以字为单位对比版本之间的差异。

方法如下：

1）在Git安装目录下，找到.gitconfig文件，并打开，如下图所示。
2）在该文件末尾，添加以下内容：
[diff "pandoc"]
 textconv=pandoc --to=markdown
 prompt = false
[alias]
 wdiff = diff --word-diff=color --unified=1
3）在Git版本库根目录下，新建一个.gitattributes文件，并写入：
*.docx diff=pandoc

Step 5：验证对docx文件的版本管理功能

1）将docx文件转化为markdown文件，并添加到版本库中。本文docx文件已在版本库中。
pandoc -s YourFile.docx -t markdown -o YourFile.md
git add YourFile.md
2）为版本库添加必要的改动备注
git commit
(blabla) #在出现的编辑窗口中输入想添加的备注
备注添加完毕后，按esc,退出编辑状态，连按两次大写字母Z提交并退出。
3）查看docx文件最新一次修改的差别.
git wdiff YourFile.docx
会发现，新修改的内容为绿色，对应被修改的内容为红色。

以上。

有观点提到Git实际可进行任何格式的文档管理，但对于二进制文档管理起来有困难或不便，未深究细里。 ↩︎