回答
從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。
你應該總是參考[the source](http://stackoverflow.com/a/19478758/1039893) – Anwar
當考慮rdoc時,也值得看看[YARD](http://yardoc.org),它以一些非常強大的方式擴展了rdoc。 –
如果這是剽竊,如果有人會在答案中引用消息來源並標記這些評論過時,那將是非常好的。此外,同樣的答案表明這些問題可能是愚蠢的,所以請考慮標記這一點。 –
RDoc是一種標記語言。 Markdown是一種不同的標記語言。 HTML是另一種標記語言。任何這些都可以用來標記文本,所有這些都可以通過各種代碼瀏覽工具來支持,包括但不限於GitHub。
RDoc - 是產生HTML和命令行文檔Ruby項目一個RubyGem。 RDoc包含用於從命令行生成和顯示文檔的rdoc和ri工具。
Markdown also known as md是設計成使得其可以任選被轉化使用相同的名稱的工具爲HTML純文本格式的語法5。 Markdown通常用作自述文件的格式,或用於在線討論論壇中撰寫郵件,或用於快速創建富文本文檔的文本編輯器中。
- 1. 什麼是col-md-4和col-md-6之間的區別
- 2. col-lg-4和col-md-3和col-xs-3有什麼區別?
- 3. MD和MKDIR批處理命令有什麼區別?
- 4. Linux內核中dm和md有什麼區別?
- 5. /MD和/ MDd(使用運行時庫)有什麼區別?
- 6. VisualStudio C++有什麼區別btw/MD和/ MDD?
- 7. 有什麼區別`和$(Bash中有什麼區別?
- 8. 有什麼區別? :和||
- 9. &&和||有什麼區別?
- 10. 「/」和「/ *」有什麼區別?
- 11. 有什麼區別:。!和:r!?
- 12. ==和===有什麼區別?
- 13. Appender和〜有什麼區別?
- 14. $ @和$ *有什麼區別?
- 15. is和=有什麼區別?
- 16. #.00和#。##有什麼區別?
- 17. `==`和`is`有什麼區別?
- 18. '=='和'==='有什麼區別?
- 19. /和/#/有什麼區別?
- 20. | 0和~~有什麼區別?
- 21. `&`和`ref`有什麼區別?
- 22. ==和===有什麼區別?
- 23. ==和===有什麼區別?
- 24. `{}`和`[]`有什麼區別?
- 25. JavaScript和=== ===有什麼區別?
- 26. difftime和' - '有什麼區別?
- 27. =和==有什麼區別?
- 28. xtype和別名有什麼區別?
- 29. Mixpanel:識別()和people.identify()有什麼區別?
- 30. 有什麼區別
這是一個奇怪的問題。你真的*想知道什麼?它們只是不同的標記語言。一個使用rdoc,另一個降價。 –