Markdown Preview
Understand Markdown Preview
Esta vista previa renderiza Markdown a HTML mientras escribe, para que vea cómo quedará un README o un comentario largo.
How it works
El Markdown se convierte mediante un conjunto de reglas aplicadas en orden: primero los bloques de código delimitados, para que su contenido se escape y se deje intacto, y después los encabezados, las citas, las líneas horizontales, las listas, el código en línea, la negrita, la cursiva y los enlaces. El HTML resultante se filtra contra una lista de permitidos — encabezados, párrafos, listas, code, pre, strong, em, blockquote, hr, br y enlaces — y se descarta todo atributo salvo un href http, https o mailto, así que el HTML en bruto del origen no puede ejecutarse.
When to use it
- Revisar los encabezados y los bloques de código de un README antes de subirlo.
- Ver si el cuerpo largo de una incidencia o de un comentario se renderizará como usted pretendía.
- Convertir un fragmento de Markdown en HTML que pueda pegar en un CMS o en un correo.
- Comprobar si una lista o un bloque de código anidado están bien escritos.
Watch out for
- Esto es un subconjunto de CommonMark, no GitHub Flavored Markdown. Las tablas, las listas de tareas, el texto tachado, las notas al pie y las imágenes no se renderizan: en su lugar se ve su texto de origen.
- Los guiones bajos dentro de una palabra se leen como énfasis, así que snake_case_name se renderiza con la palabra del medio en cursiva. CommonMark deliberadamente no hace eso; envuelva los identificadores en comillas invertidas.
- El anidamiento es superficial. Una lista dentro de una cita, o una sublista sangrada, no saldrá como la produce un analizador completo.
- El HTML en bruto del origen queda reducido a su contenido de texto por el sanitizador. Es intencionado, y hace que esta vista previa sea más estricta que GitHub, que permite un conjunto limitado de etiquetas.
Not the right tool for: Confirmar exactamente cómo renderizará GitHub un archivo. GitHub añade sus propias extensiones y su propio sanitizador sobre CommonMark; para una comprobación exacta, suba el archivo a una rama y mírelo.
Frequently Asked Questions
¿Qué sintaxis de Markdown se admite?
La especificación CommonMark: encabezados con # (6 niveles), **negrita**, *cursiva*, `código en línea`, ```bloques de código delimitados```, [enlaces](url), , listas sin orden con -, listas ordenadas con 1., citas con >, líneas horizontales con --- y la sintaxis de | tablas |.
¿Cómo previsualizo un README de GitHub?
Pegue el contenido de su README.md en el editor. GitHub usa un analizador estricto de CommonMark con extensiones adicionales de GFM (GitHub Flavored Markdown) para listas de tareas, tablas y texto tachado. La vista previa se aproxima mucho al renderizado de GitHub.
¿Puedo exportar el HTML renderizado?
Sí: pulse "Copiar HTML" para obtener la salida HTML renderizada. Resulta útil para pegar contenido con formato en clientes de correo, en gestores de contenidos que aceptan HTML o en plantillas de correo HTML.
How to Use Markdown Preview
- Paste or type your input in the input area above.
- The tool processes your input automatically or click Run.
- Copy or download the result using the action buttons.
- Use Ctrl+Enter to run quickly from the keyboard.