style - slate ruby
¿Cuál es la diferencia entre rdoc y md? (3)
De ¿Cómo debo estructurar mi archivo README.rdoc? por kiddorails :
RDoc es una herramienta fantástica que permite la generación automática de HTML formateado que contiene nuestro código documentado.
Por ejemplo, la mayoría de las gemas en RubyGems obtienen la documentación y las compilan para proporcionar el rdoc resultante.
Si su proyecto no tiene README.md, GitHub puede analizar README.rdoc para mostrar los detalles. Si tiene ambos, usará README.md, ignorando silenciosamente rdoc. Normalmente tengo ambos, README.md para Github y README.rdoc para la documentación de RDoc en RubyGems.
El proyecto ruby on rails estándar tiene README.rdoc. Muchos proyectos de rieles github tienen README.md.
¿Cuál es la diferencia?
RDoc es un lenguaje de marcas. Markdown es un lenguaje de marcado diferente. HTML es otro lenguaje de marcas. Cualquiera de estos se puede usar para marcar texto, y todos ellos son compatibles con varias herramientas de búsqueda de códigos, incluidas, entre otras, GitHub.
RDoc : es un RubyGem que produce HTML y documentación de línea de comandos para proyectos de Ruby. RDoc incluye las herramientas rdoc y ri para generar y mostrar documentación desde la línea de comandos.
Markdown, también conocido como md, es una sintaxis de formato de texto simple 5 diseñada para que, opcionalmente, se pueda convertir a HTML usando una herramienta con el mismo nombre. Markdown se usa popularmente como formato para archivos readme, o para escribir mensajes en foros de discusión en línea o en editores de texto para la creación rápida de documentos de texto enriquecido.