用 markdown 文档完全替代 word 文档的可行性

目前公司正在讨论后续文档管理的策略，在方案选型的时候，在 word 和 markdown 之间有些犹豫。

主要是分析了现有文档管理情况，然后考虑新项目的文档如何管理。大致情况如下：
1.硬件团队的嵌入式的代码直接使用文本文件的 README，甚至用 ASCII 化简图（有非常 nb 的老工程师在驱动代码文件头部用 ASCII 拼除了芯片引脚和寄存器移位的示意图，这种只能膜拜，绝壁是不能动的）。
2.软件团队内部主要使用 Sphinx，部分 java 代码相关的用 javadoc。
3.系统架构、需求方面以 word 文档为主，有不少内嵌的 UML 截图，visio 截图。
4.测试文档也是用的 word 编写，测试用例主要是 excel 模板管理，测试报告也是 excel 套 word 模板生成的，一边测一边填 excel，测完运行一个宏直接生成。
5.用户手册也是用的 Word 模板，然后人工编写。
6.各个部门内部有一些比较好的经验分享类的文章，也是用 word 编制的，很多都是图文并茂。

现在的主要问题是这些文档都是独立的文档，公司想把这些文档做成某种能够在线检索的知识库，同时还要考虑以下问题：
1，去微软化，彻底替换 word，而且不考虑 WPS，文档格式需要能够完全透明，根据自己的需要检索、解析或者批量处理，能用 git 进行版本管理。
2，显示输出要保持同类型 word 文档的层次和条目，不能跟以前老项目的文档看起来有很大不同，细微的差别可以接受。
3，必须能够像 word 那样在 A4 纸上分页打印输出，同时如果在线查看也能像 HTML 那样连续输出一整篇。
4，能够导出成 pdf 作为离线的电子版发布。
5，一篇文章作为一个文件，图片必须内嵌到文章里，不能以链接的方式单独存放。
6，支持离线编辑，支持图文混和编辑，所见即所得。

我已经在 word 上面做了大量尝试，包括使用 sharepoint 来进行版本管理，这套方案还是太厚重了，sharepoint 的版本管理和 git 还不太一样。另外在网上看见有方案是用 BASE64 编码图片然后内嵌到 markdown 文档里面，不知道较大的图片是否可行。文档格式方面其实没有特别复杂的需求，刚性的主要是图文混排，分段，加粗加黑，缩进这些，word 和 wps 的格式其实已经太复杂了，很多功能用不上。

大家有没有其他好的实践，希望能分享一下。

jdhao

2019-06-18 22:26:02 +08:00

Markdown 复杂排版还是不行，楼上说的表格就是一个弱项，只能处理比较标准的表格，一旦涉及到单元格合并等等，就不行了。另外图片的并列等，也不太好弄，只能 hack。

我最近在写一个文档，就是用 Markdown，然后使用 pandoc 转为 PDF，就需要用到 LaTeX 的一些知识，我自己懂，所以还好，你要做出精美的文档，不懂 LaTeX 是不太行的，但是让普通人学习 LaTeX，感觉难度比较高，不太好推广。

我写了一篇从 Markdown 生成 PDF 的博文，把所有能想到的问题和坑都写了，地址在 https://jdhao.github.io/2019/05/30/markdown2pdf_pandoc/

楼主可以试一下，遇到问题可以交流一哈