Para mí no está claro cuál es el formato, si hay requisitos sistemáticos / de línea de comandos para crearlo, etc.
Básicamente, solo para saber las especificaciones, y si hay pasos técnicos para generar el archivo README.
Para mí no está claro cuál es el formato, si hay requisitos sistemáticos / de línea de comandos para crearlo, etc.
Básicamente, solo para saber las especificaciones, y si hay pasos técnicos para generar el archivo README.
Respuestas:
Markdown es una sintaxis simple para proporcionar información semántica y representar formatos comunes en texto plano. Daring Fireball tiene una increíble guía de sintaxis para el descuento estándar . GitHub luego usa una variante de esto que llaman GitHub Flavored Markdown .
Para configurar su archivo Léame, simplemente cree un archivo de texto plano y asígnele el nombre README (o README.md / README.markdown) y confírmelo a la raíz de su repositorio. GitHub lo recogerá como el archivo Léame del proyecto.
Wikipedia - Markdown hace referencia a la página "GitHub Flavored Markdown - Introducción" ( archv. )
Cita de la página:
GitHub usa lo que llamamos "GitHub Flavored Markdown" (GFM) para mensajes, problemas y comentarios. Se diferencia del Markdown estándar (SM) en algunas formas significativas y agrega algunas funcionalidades adicionales.
La página también ofrece una descripción de las diferencias con Markdown estándar.
También hay más información sobre cómo GitHub representa realmente Markdown:
Si está interesado en cómo representamos los archivos Markdown, puede consultar Redcarpet , nuestra interfaz Ruby para la biblioteca Sundown .
(Aparentemente, Sundown es el analizador de Markdown real que se usa detrás de las cortinas).
Para agregar una capa más de abstracción, Sundown es una bifurcación de incluso otro analizador Markdown :-)
Cita de la página GitHub de Sundown :
Sundown es un analizador Markdown basado en el código original de la biblioteca Upskirt de Natacha Porté.
Es muy extraño, pero parece que GitHub no usa GitHub-Flavored Markdown (GFM) al renderizar un archivo README.
GitHub utiliza "GitHub Flavored Markdown", o GFM, en todo el sitio, en problemas, comentarios y solicitudes de extracción.
En cambio, parece usar una versión llamada redcarpet como parte del proyecto de marcado GitHub . También admiten varios otros formatos de marcado, incluido MediaWiki. Simplemente use la extensión de archivo correcta y GitHub mostrará el marcado.
Si desea ver las diferencias entre los dos sabores diferentes de Markdown, lea la descripción de GFM y sus características adicionales .