什么是最适合git的文档格式？

Question

我们使用.docx和.odt来实现我们以人为本的＃34;文档，但这些格式几乎是你可以对git存储库做的最差的。

是否有一些git友好格式提供基本的文字处理器功能并将所有内容包含在一个文件中？

Answer 1

有许多格式友好的格式。例如：

• Markdown，HTML和XML已在评论中指出。这些文件不能单独包含图像，但您可以对图像进行引用（例如，在同一目录或资源子目录中，例如带有markdown的[GitHub Logo](/images/logo.png)或<img src="images/logo.png">在HTML）。它不像在docx或odt中复制/粘贴那么方便，但它的git友好，特别是如果图片不经常更改
许多文字处理包都支持
• Rich Text Format (RTF)。它允许嵌入图片并以文本友好格式存储（二进制图片嵌入文本编码）。

Answer 2

对于文档而言， AsciiDoc 比Markdown更适合。乍看起来，它看起来很相似，具有相同的基本思想，即源代码模仿最终外观，但是它具有Markdown所具有的所有丰富文本功能，而Markdown只能通过大量非官方的，不兼容的语言扩展来实现。它也得到广泛支持，例如由Github，Bitbucket以及Atom和VS Code等编辑器提供的插件。

Answer 3

短：使用TopicTaskConcurrentDictionary.Instance.CollectionChanged += delegate (object o, NotifyCollectionChangedEventArgs e) { foreach (KeyValuePair<KeyValuePair<string, string>, IDataPipesService> item in TopicTaskConcurrentDictionary.Instance) { ; } }; var dataService = _kernel.Get<IDataService>(); TopicTaskConcurrentDictionary.Instance.TryAdd(new KeyValuePair<string, string>(param.TagPrefix, param.TopicName), dataService); （LibreOffice Writer）和ReZipDoc (GPLv3)（免责声明：我维护）

---

说明：

相当多的二进制格式-其中*.odt（MS Word）和docx（LibreOffice Writer）-只是包含文本文件和二进制文件的ZIP文件。 使用git过滤器，您无需压缩即可重新压缩它们，这使得它们更容易压缩为git，从而节省了git历史记录中的大量空间，并且还使它们以非常友好的格式进行比较，而无需使用额外的diff工作流程。但是，大多数编辑软件使用这些文件而不是压缩文件都没有问题。主要缺点：每个操作仓库的人都必须安装过滤器

为此工作流程制作了ReZipDoc（GPLv3）工具；它包含一个git过滤器。

与不使用此类过滤器相比，您在文档中使用的二进制文件（例如图像）越来越多，并且更改的频率越少，每次文档的文本部分更改时您节省的空间就越大。

尽管如此，我必须说从技术上以及个人角度，我也建议Markdown而不是这样的解决方案。 已经有了不错的GUI编辑器。