Git配合Pandoc实现Word需求文档的迭代

目录


1 方案简介

1.1 背景

  • Git在提交Word时,对于Word的变动显示并不友好
  • 在查看历史版本或者远端仓库时,Word文档的显示可能为“二进制文件不可显示”,根本无法查看变动
  • Git对Word的支持并不完善

1.2 Pandoc

  • Pandoc可以将Word文档转换成其他类型的文档
  • 支持的文档类型:
    • HTML formats:XHTML, HTML5, and HTML slide shows using Slidy, reveal.js, Slideous, S5, or DZSlides
    • Word processor formats:Microsoft Word docx, OpenOffice/LibreOffice ODT, OpenDocument XML, Microsoft PowerPoint
    • Ebooks:EPUB version 2 or 3, FictionBook2
    • Documentation formats:DocBook version 4 or 5, TEI Simple, GNU TexInfo, roff man, roff ms, Haddock markup
    • Archival formats:JATS
    • Page layout formats:InDesign ICML
    • Outline formats:OMPL
    • TeX formats:LaTeX, ConTeXt, LaTeX Beamer slides
    • PDF:via pdflatex, xelatex, lualatex, pdfroff, wkhtml2pdf, prince, or weasyprint
    • Lightweight markup formats:Markdown (including CommonMark and GitHub-flavored Markdown), reStructuredText, AsciiDoc, Emacs Org-Mode, Emacs Muse, Textile, txt2tags, MediaWiki markup, DokuWiki markup, TikiWiki markup, TWiki markup, Vimwiki markup, and ZimWiki markup
    • Interactive notebook formats:Jupyter notebook (ipynb)

1.3 解决方案

  • 在提交Word时,在本地将Word由Pandoc转换成Markdown格式的文档
  • Git在远端查看变动时,就能够通过自动生成的Markdown文件查看变动

2 Pandoc安装

2.1 Windows版本安装

  • 通过Pandoc官网下载Windows版本安装包
  • 执行安装包,安装

2.2 macOS版本安装

  • 打开"终端"
  • 使用Homebrew进行安装:
brew install pandoc

3 Pandoc设置

  1. 设置全局配置文件gitconfig(Windows下路径"c:\Documents and Settings\user\.gitconfig"或者macOS下路径"~/.gitconfig"),在文件末尾添加如下信息:
[diff "pandoc"]
   textconv=pandoc --to=markdown
   prompt = false
[alias]
   wdiff = diff --word-diff=color --unified=1
  1. 在项目根目录下添加或者编辑文件.gitattributes,在文件中加入如下信息:
*.docx diff=pandoc
  1. 至此,git在进行文件对比时优先将Word文件转换为md文件然后进行对比

4 提交脚本安装

附:

  1. 集成docx文件diff程序
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 158,847评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,208评论 1 292
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,587评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,942评论 0 205
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,332评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,587评论 1 218
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,853评论 2 312
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,568评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,273评论 1 242
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,542评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,033评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,373评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,031评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,073评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,830评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,628评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,537评论 2 269

推荐阅读更多精彩内容

  • PANDOC Markdown是我平时编写各类材料和文章时最喜欢的工具之一,但将其作为文档分发时却略有些不便。毕竟...
    榴莲气象阅读 142,987评论 2 43
  • 家里小朋友3岁半。想建个沈阳的妈妈群,在这里大家可以交流孩子的教育,饮食,沈阳以及周边哪里好玩,因为都是沈...
    麟麟妈阅读 206评论 1 0
  • 在一个很难跳出的怪圈里,选择了与心对话,与自己独处,随心而动,也做出一些选择:毅然的选择了分手,决定了一个去...
    张小迪_dd阅读 272评论 0 0
  • ❤️ 点开微博,点开腾讯,点开微信群,点开空间,点开公众号,都在谈论薛之谦,都说,...
    绿河219阅读 854评论 0 2
  • 亲爱的女儿, 妈妈祝贺你顺利进入高等院校继续你的学业!虽然对你来说,这次高考不算理想,但是你应该庆幸今天的缺...
    龙语阅读 3,297评论 1 13