Стандартный проект ruby on rails имеет README.rdoc. Многие проекты github rails имеют README.md.
В чем разница?
В чем разница между rdoc и md?
Ответ 1
Из Как мне создать файл README.rdoc? kiddorails:
RDoc - это фантастический инструмент, который позволяет автоматически генерировать форматированный HTML, содержащий наш документированный код.
Например, большая часть драгоценных камней на RubyGems извлекает документацию и компилирует их для получения результирующего rdoc.
Если ваш проект не имеет README.md, GitHub может анализировать README.rdoc для отображения деталей. Если он есть, он будет использовать README.md, молча игнорируя rdoc. Обычно у меня есть как README.md для Github, так и README.rdoc для документации RDoc на RubyGems.
Ответ 2
RDoc - это RubyGem, который создает документацию по HTML и командной строке для проектов Ruby. RDoc включает инструменты rdoc и ri для генерации и отображения документации из командной строки.
Markdown, также известный как md, является синтаксисом форматирования простого текста 5, чтобы он мог быть преобразован в HTML с помощью инструмента с тем же именем. Markdown широко используется в качестве формата для файлов readme или для написания сообщений на онлайновых дискуссионных форумах или в текстовых редакторах для быстрого создания полнотекстовых документов.
Ответ 3
RDoc - это язык разметки. Markdown - это другой язык разметки. HTML - еще один язык разметки. Любой из них можно использовать для разметки текста, и все они поддерживаются различными инструментами просмотра кода, включая, помимо прочего, GitHub.