documentation - ASCII 文本文档的样式指南

Question

什么是仅使用 ASCII 文本格式化文档、大纲和程序描述的好的样式指南？

我正在考虑使用大写、“下划线”（下一行带有“-”或“=”）、缩进等的一组规则，以帮助在视觉上将文本组织成部分、小节等。

vi 支持的指南会特别好。

Answer 1

考虑使用Markdown或MultiMarkdown来格式化纯文本文档。有一个vim Markdown 语法插件可用，它在 Stack Overflow 和 GitHub 上被广泛使用：

https://stackoverflow.com/editing-help

https://help.github.com/articles/github-flavored-markdown

Answer 2

除了 Markdown 和reStructuredText之外，还有AsciiDoc，它比 Markdown 更强大：有 f.ex。定义如何用ASCII 文本编写 图表的插件。

AsciiDoc 不如 Markdown 受欢迎，但在Github 现在也支持 AsciiDoc之后，它会变得更受欢迎。

所有这三种文本格式也都有 vim 插件。