2014-06-05 41 views
17

標準ruby on rails項目有README.rdoc。 許多github rails項目都有README.md。rdoc和md有什麼區別?

有什麼區別?

+0

這是一個奇怪的問題。你真的*想知道什麼?它們只是不同的標記語言。一個使用rdoc,另一個降價。 –

回答

14

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。

+6

你應該總是參考[the source](http://stackoverflow.com/a/19478758/1039893) – Anwar

+0

當考慮rdoc時,也值得看看[YARD](http://yardoc.org),它以一些非常強大的方式擴展了rdoc。 –

+0

如果這是剽竊,如果有人會在答案中引用消息來源並標記這些評論過時,那將是非常好的。此外,同樣的答案表明這些問題可能是愚蠢的,所以請考慮標記這一點。 –

2

RDoc是一種標記語言。 Markdown是一種不同的標記語言。 HTML是另一種標記語言。任何這些都可以用來標記文本,所有這些都可以通過各種代碼瀏覽工具來支持,包括但不限於GitHub。

4

RDoc - 是產生HTML和命令行文檔Ruby項目一個RubyGem。 RDoc包含用於從命令行生成和顯示文檔的rdoc和ri工具。

Digging Deeper Rdoc

Markdown also known as md是設計成使得其可以任選被轉化使用相同的名稱的工具爲HTML純文本格式的語法5。 Markdown通常用作自述文件的格式,或用於在線討論論壇中撰寫郵件,或用於快速創建富文本文檔的文本編輯器中。

Github's Markdown

Github's Markdown basics