ASCII文本文档的样式指南

时间:2013-02-15 14:53:02

标签: documentation formatting styles

使用ASCII文本格式化文档,大纲和过程描述的好样式指南是什么?

我正在考虑一组使用大写的规则,'下划线'(在下面的行中带有' - '或'='),缩进等,以帮助在视觉上将文本组织成部分,子部分等。

vi支持的指南特别好。

2 个答案:

答案 0 :(得分:2)

考虑使用MarkdownMultiMarkdown格式化纯文本文档。有一个vim Markdown syntax plugin可用,它在Stack Overflow和GitHub上广泛使用:

https://stackoverflow.com/editing-help

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

答案 1 :(得分:0)

除了Markdown和reStructuredText之外还有AsciiDoc,它比Markdown更强大:有f.ex.插件定义了write diagrams in ASCII文本的方式。

AsciiDoc不如Markdown受欢迎,但在Github supports now AsciiDoc too之后它会变得更受欢迎。

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