Documentation 比较和对比轻量级标记语言

请确定最流行的轻量级标记语言，并比较它们的优缺点。这些语言应该是技术散文的通用标记，例如文档（例如，Haml不计算在内）

---

另请参见：

我知道在大型编程和技术社区中常用的三种主要语言：Textile、Markdown和reStructuredText。这三种方法都可以在几个小时内学会，也可以在附近的备忘单上“飞起来”

织物

• Redmine和Ruby社区使用
• 113个当前标记为堆栈溢出的问题
• 最类似于HTML，但可读性最低的源代码
• 所有三种语言的最简单嵌套列表
• 非程序员或HTML无知者无法理解
• 非常适合复杂的短文档（带有链接、嵌套列表、代码、自定义HTML）；例如：简短文档、how tos、博客或CMS内容

降价

• 似乎没有家庭语言的“社区”，但
• 1274个问题标记为堆栈溢出*
• 强调源代码的可读性，类似于电子邮件传统
• 简单的HTML嵌入（只需键入标记）
• 除了嵌入HTML之外，没有办法制作表
• 如果您知道堆栈溢出，那么您已经知道了
• 如果您已经了解StructuredText，则易于学习
• 格式的自动电子邮件地址混淆

重组文本（又称ReST）

• 流行于Python社区
• 285个问题标记为堆栈溢出
• 如果你问我的话，关于空格和对齐有点挑剔
• 列表（尤其是嵌套的列表）和段落似乎总是在争吵
• 非程序员可读
• 唯一可以构建目录的格式（通过Python参考实现中的扩展）
• 直接转换为其他格式，如PDF和XML
• 非常适合包含大量散文的大型文档（例如，用户手册的docbook替代品）

你也可以考虑

• 相对可读的标记
• 直接的命令行使用
• 有些人可能认为它在语法方面相对“挑剔”（而不是灵活）
• docbook和（x）html输出

文件？ 怎么样
我已经将它用于一些需要文档化的c/c++项目。

---

甚至您也可以像doxygen author用于doxygen文档一样“滥用”它

我试图在这里介绍各种轻量级标记语言：

正如您所看到的，它从“如何创建一个安全的博客”开始，即生成静态HTML的博客，我发现自己陷入了标记语言、模板系统等的陷阱

更新

我将重点放在使用python实现的LWML上，它们如下所示：

到目前为止，我已经尝试过降价和休息，我更喜欢后者

---

嵌入在其他页面中的HTML片段。表、交叉引用、间接链接等。

上的Wikipedia页面对各种选项进行了很好的比较，并为ReST用户显示了常用语法（标题、粗体、斜体等）

，对于大型树结构的参考文档集合来说，这看起来是一个非常好的工具。当我在Emacs中硬包装东西时，我对StructuredText中的列表和段落没有任何问题。事实上，它们的功能与我所期望的完全一样：-）有一些标记扩展，允许以ASCII格式组合表。ReST也有很好的工具支持：例如，基于浏览器的工具是一个很好的工具，可以尝试、学习和使用ReST（基于sphinx.pocoo.org后端）。不幸的是，对于包含多个段落的列表项，Ascidoc的语法很糟糕：您必须用一行只包含加号（是的，一个“+”）的行来分隔它们。@Martin:多段落列表项真的那么重要吗？如果你需要不止一个段落，标题/章节不是比列表更合适吗？AsciiDoc最大的优点是它支持更多的功能。它可以创建书籍，有提示部分，许多输出。。。另见