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

时间:2009-03-18 17:10:41

标签: documentation markdown markup restructuredtext textile

请确定最受欢迎的轻量级标记语言,并比较它们的优缺点。这些语言应该是技术散文的通用标记,例如文档(例如,Haml不计算在内)。

另请参阅:Markdown versus ReStructuredText

5 个答案:

答案 0 :(得分:115)

我知道在大型编程和技术社区中常用的三种主要语言:Textile,Markdown和reStructuredText。这三个都可以在几个小时内学会,或者用附近的备忘单“飞过”。

纺织

  • 由Redmine和Ruby社区使用
  • 目前在Stack Overflow上标记的113个问题
  • 最类似于HTML,但最不可读的来源
  • 所有三种语言的最简单嵌套列表
  • 非程序员或HTML无知
  • 无法理解
  • 适用于复杂的短文档(包含链接,嵌套列表,代码,自定义HTML);例如:简短文档,how-tos,博客或CMS内容
  • Syntax reference

降价

  • 似乎没有家庭语言“社区”,但......
  • 在Stack Overflow上标记了1274个问题*
  • 强调源代码可读性,类似于电子邮件传统
  • 直接的HTML嵌入(您只需输入标签)
  • 除了嵌入HTML
  • 之外,无法制作表格
  • 如果你知道Stack Overflow
  • ,你就已经知道了
  • 如果您已经了解reStructuredText
  • ,则易于学习
  • 格式为< address@example.com>的自动电子邮件地址模糊处理; (带尖括号)
  • Syntax reference

reStructuredText(A.K.A。ReST)

  • 在Python社区中很受欢迎
  • Stack Overflow上标记的285个问题
  • 如果你问我,有点怀疑空白和对齐
  • 列表(特别是嵌套列表)和段落似乎总是打架
  • 非程序员可读
  • 只能构建目录的格式(通过Python参考实现中的扩展名)
  • 直接转换为PDF和XML等其他格式
  • 非常适合包含大量散文的大型文档(例如,用户手册的docbook替代方案)
  • Syntax reference

答案 1 :(得分:31)

您也可以考虑asciidoc

  • 相对可读的标记
  • 简单的命令行使用
  • 有些人可能认为它在语法
  • 方面相对“挑剔”(相对于灵活)
  • docbook和(x)html输出

答案 2 :(得分:21)

lightweight markup languages上的维基百科页面对各种选项进行了很好的比较,并显示了常用的语法(标题,粗体,斜体等)

答案 3 :(得分:5)

我试图在这里涵盖所有各种轻量级标记语言:

http://www.subspacefield.org/~travis/static_blog_generators.html

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

<强>更新

我只重点关注使用python实现的LWML,它们就在这里:

http://www.subspacefield.org/~travis/python_lightweight_markup_languages.html

到目前为止,我已经尝试过markdown和ReST,而且我更喜欢后者 嵌入在其他页面中的HTML片段。表格,交叉引用,间接链接等......

答案 4 :(得分:4)

文件? doxygen怎么样?
我已将它用于我需要记录的一些c / c ++项目。 即使你可以“滥用”它就像doxygen作者用于doxygen文档