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

标签 documentation markdown markup restructuredtext textile

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

另请参阅:Markdown versus ReStructuredText

最佳答案

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

纺织

  • 由 Redmine 和 Ruby 社区使用
  • 目前在 Stack Overflow 上标记了 113 个问题
  • 与 HTML 最相似,但可读性最差的源代码
  • 所有三种语言的最简单嵌套列表
  • 非程序员或不懂 HTML 的人无法理解
  • 非常适合复杂的短文档(带有链接、嵌套列表、代码、自定义 HTML);例如:简短的文档、操作方法、博客或 CMS 内容
  • Syntax reference

Markdown

  • 似乎没有母语“社区”,但是......
  • Stack Overflow 上标记了 1274 个问题*
  • 强调源代码的可读性,类似于电子邮件传统
  • 直接的 HTML 嵌入(您只需键入标签即可)
  • 除了嵌入 HTML 之外无法制作表格
  • 如果您了解 Stack Overflow,您就已经了解了
  • 如果您已经了解 reStructuredText,那么学习起来很容易
  • 自动对电子邮件地址进行混淆,格式为 (带尖括号)
  • Syntax reference

reStructuredText(又名 ReST)

  • 在 Python 社区中很受欢迎
  • Stack Overflow 上标记了 285 个问题
  • 如果你问我的话,我对空格和对齐有点挑剔
  • 列表(尤其是嵌套列表)和段落似乎总是会发生冲突
  • 非程序员可读
  • 唯一可以构建目录的格式(通过 Python 引用实现中的扩展)
  • 直接转换为其他格式,例如 PDF 和 XML
  • 非常适合包含大量散文的大型文档(例如用户手册的 docbook 的替代品)
  • Syntax reference

关于documentation - 比较和对比轻量级标记语言,我们在Stack Overflow上找到一个类似的问题: https://stackoverflow.com/questions/659227/

相关文章:

javascript - 向 JavaScript 函数添加文档的标准方法是什么?

list - 是否有已知的网络爬虫列表?

java - 是否可以设置Hibernate的 "default"变量名映射?

javascript - URL 在 javascript 框架 (BotUI) 中丢失其标记

github - Shield.IO 许可证徽章和 Github。许可证徽章不起作用

.net - .Net 项目 (SandcaSTLe) 的命名空间文档?

c - Doxygen 中的所见即所得

javascript - 通过 jQuery.get() 读取 markdown 文件

java - 转换字符串; java中的键盘输入

python-2.7 - Jupyter Notebook 不支持 MARKDOWN 单元格中的笑脸