rails项目上的标准ruby具有README.rdoc。 许多github rails项目都有README.md。
有什么区别?
答案 0 :(得分:13)
How should I structure my README.rdoc file?来自kiddorails:
RDoc是一个很棒的工具,可以自动生成包含我们记录的代码的格式化HTML。
例如,RubyGems上的大多数gem都会获取文档并编译它们以提供结果rdoc。
如果您的项目没有README.md,GitHub可能会解析README.rdoc以显示详细信息。如果它有两者,它将使用README.md,默默地忽略rdoc。我通常同时拥有Github的README.md和RubyGems上的RDoc文档的README.rdoc。
答案 1 :(得分:5)
RDoc - 是一个RubyGem,它为Ruby项目生成HTML和命令行文档。 RDoc包括用于从命令行生成和显示文档的rdoc和ri工具。
Markdown also known as md是一种纯文本格式语法5,旨在使用相同名称的工具将其转换为HTML。 Markdown通常用作自述文件的格式,或用于在在线论坛或文本编辑器中编写消息,以便快速创建富文本文档。
答案 2 :(得分:3)
RDoc是一种标记语言。 Markdown是一种不同的标记语言。 HTML是另一种标记语言。其中任何一个都可用于标记文本,所有这些都受到各种代码浏览工具的支持,包括但不限于GitHub。