Markdown Preview
Live Markdown preview
Live Markdown preview Se ejecuta localmente en su navegador
About the
La vista previa de Markdown muestra su Markdown a medida que escribe, en una vista de lado a lado, siguiendo CommonMark con las extensiones de GitHub que la mayoría de la gente realmente usa: tablas, listas de tareas, bloques de código delimitados, tachados y enlaces automáticos. Es la forma más rápida de verificar un archivo README antes de enviarlo, porque las diferencias entre cómo se ve Markdown en el código fuente y cómo se ve renderizado no son obvias, y la sintaxis de la tabla en particular falla silenciosamente cuando una sola barra vertical o guión es incorrecto. El HTML renderizado también se puede copiar si lo necesita en algún lugar que no procese Markdown.
Where people use the
- Verificar que un archivo README se reproduzca correctamente antes de enviarlo.
- Redactar notas de la versión o un registro de cambios con una vista en vivo del resultado.
- Convertir un documento Markdown a HTML para un CMS que no acepta Markdown.
- Revisar la solicitud de extracción Markdown de otra persona y ver cómo se verá.
How to use the
- 1
Pega o escribe tu Markdown
El editor acepta cualquier cosa, desde un solo párrafo hasta un documento completo con títulos, listas, enlaces y vallas de código.
- 2
Mira el panel renderizado
La vista previa se actualiza con cada pulsación de tecla, por lo que una mesa rota o una valla sin cerrar aparece inmediatamente en lugar de después de un paso de publicación.
- 3
Corrija la fuente, no la vista previa
La vista previa es de sólo lectura. Cuando algo se muestra mal, la causa casi siempre es que falta una línea en blanco antes de una lista o un encabezado de tabla sin una fila delimitadora.
- 4
Copie el HTML si lo necesita
Cambie a la vista HTML para tomar el marcado generado, lo cual es útil para pegarlo en un CMS que espera HTML en lugar de Markdown.
Consejos y mejores prácticas
- Deje una línea en blanco antes y después de cada elemento del bloque; Los errores de renderizado más desconcertantes son la falta de una línea en blanco.
- Utilice bloques de código delimitados con un nombre de idioma para que el código se resalte en lugar de tratarse como texto sin formato.
- Mantenga una oración por línea en documentos largos; hace que las diferencias sean legibles más tarde.
Preguntas frecuentes
¿Qué especificación Markdown se utiliza?
CommonMark como base, además de las extensiones GitHub Flavored Markdown para tablas, listas de tareas, código delimitado y tachado. Esa combinación cubre el formato README en GitHub, GitLab y la mayoría de los sitios de documentación.
¿Por qué mi tabla no se procesa?
Una tabla necesita una fila de encabezado seguida inmediatamente por una fila delimitadora de guiones, con una línea en blanco antes del bloque. Cada fila debe tener la misma cantidad de tuberías que el encabezado. Cualquiera de los que faltan convierte todo en un párrafo de texto con caracteres verticales.
¿Por qué los elementos de mi lista se fusionaron en un solo párrafo?
Markdown necesita una línea en blanco entre un párrafo y una lista que le sigue. Sin él, los marcadores de lista se tratan como texto normal.
¿Es compatible con LaTeX o matemáticas?
No. La representación matemática necesita una biblioteca separada como KaTeX o MathJax y una sintaxis diferente. Una expresión de signo de dólar aquí se representará como texto sin formato.
¿Se permite HTML sin formato?
Sí, el HTML en línea pasa directamente, que es lo que también hace GitHub. Si publica el resultado en algún lugar público, desinféctelo primero, porque el HTML sin formato también es la forma en que se inyectan los scripts.
¿A dónde va mi texto?
En ningún lugar. El análisis y la representación se realizan en su navegador con una biblioteca JavaScript Markdown. No se guarda ni transmite nada, por lo que el borrador desaparece cuando cierra la pestaña a menos que lo copie.