Vista previa de Markdown
Markdown es un lenguaje de marcado ligero para crear texto formateado usando sintaxis de texto plano. Popular para documentación, archivos README y toma de notas, se renderiza a HTML para su visualización. Esta herramienta previsualiza Markdown con renderizado en vivo, extrae la estructura del documento (encabezados, enlaces, imágenes) y puede convertir a HTML.
Especificaciones
Casos de uso comunes
- Previsualizar archivos README.md antes de hacer commit
- Revisar el formato de documentación
- Extraer todos los enlaces de un documento para validación
- Convertir Markdown a HTML para incrustar
- Analizar la estructura y navegación del documento
Funcionalidades
- Vista previa en vivo con renderizado HTML
- Extraer estructura del documento (encabezados como tabla de contenidos)
- Listar todos los enlaces e imágenes del documento
- Detectar y mostrar bloques de código con indicadores de lenguaje
- Analizar frontmatter (metadatos YAML)
- Convertir a salida HTML limpia
- Estadísticas de conteo de palabras y caracteres
Ejemplos
README con características
Pruébalo →Un README de proyecto típico con encabezados, listas y código.
# My Project
A brief description of what this project does.
## Installation
```bash
npm install my-project
```
## Features
- **Fast** - Optimized for speed
- **Simple** - Easy to use API
- **Flexible** - Works with any framework
## Links
- [Documentation](https://docs.example.com)
- [GitHub](https://github.com/example/project)Consejos
- Use # para encabezados (# H1, ## H2, ### H3, etc.).
- Los bloques de código usan triple comilla invertida con un identificador de lenguaje opcional.
- Los enlaces usan la sintaxis [texto](url); las imágenes usan .
- El frontmatter entre líneas --- puede contener metadatos YAML.
Comprender Vista previa de Markdown
Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004, diseñado para ser legible como texto plano mientras se convierte limpiamente a HTML. Su sintaxis usa caracteres de puntuación que sugieren visualmente su formato: # para encabezados, * para énfasis, - para listas y comillas invertidas para código. Los archivos Markdown siguen siendo útiles incluso sin renderizar, lo cual es la razón por la que el formato domina para documentación, archivos README y escritura técnica.
La especificación CommonMark (2014) abordó las muchas ambigüedades del Markdown original. CommonMark define con precisión cómo se manejan los casos límite, y la mayoría de los analizadores modernos lo implementan. GitHub Flavored Markdown (GFM) extiende CommonMark con tablas, listas de tareas, tachado, URLs con enlace automático y bloques de código delimitados con resaltado de sintaxis.
GFM es el estándar de facto para archivos README, descripciones de pull requests, comentarios en issues y sitios de documentación. La mayoría de las plataformas de documentación (Notion, Docusaurus, MkDocs, GitBook) soportan GFM o un superconjunto de él.
El frontmatter es una convención común para agregar metadatos estructurados a archivos Markdown. Un bloque YAML delimitado por líneas --- al inicio del archivo puede contener título, fecha, autor y etiquetas usadas por generadores de sitios estáticos (Astro, Hugo, Jekyll, Next.js) para construir navegación y diseños de página.
En la práctica, "Markdown" casi siempre se refiere a CommonMark o GFM. La especificación original de Markdown dejó muchos casos límite sin definir, y CommonMark resolvió esas ambigüedades con una especificación estricta. GFM extiende CommonMark con tablas, listas de tareas, tachado y URLs con enlace automático. Al evaluar un analizador o renderizador de Markdown, verificar su conformidad con CommonMark es un indicador confiable de qué tan bien maneja los casos límite.
Las tablas en GFM usan barras verticales (|) para separar columnas y guiones (-) para la fila divisoria del encabezado. La alineación de columnas se controla con dos puntos en el divisor: :--- para alineación izquierda, :---: para centrado y ---: para alineación derecha. Las tablas son una extensión de GFM y no forman parte de la sintaxis original de Markdown. El frontmatter, delimitado por líneas --- al inicio del archivo, es un bloque de metadatos YAML usado por generadores de sitios estáticos para metadatos de página como título, fecha, diseño y etiquetas. GitHub renderiza el frontmatter como una tabla en la parte superior del archivo, aunque no todos los renderizadores lo procesan.
Los bloques de código delimitados usan triple comilla invertida con un identificador de lenguaje opcional después de las comillas invertidas de apertura — por ejemplo, una línea con tres comillas invertidas seguidas de "javascript" inicia un bloque de JavaScript con resaltado de sintaxis. Los identificadores de lenguaje disponibles dependen de la plataforma de renderizado. Indentar código por cuatro espacios también crea un bloque de código, pero sin la capacidad de especificar un lenguaje para el resaltado.