PreviewMD para Mac, iPad y iPhone
Obtener

Qué renderiza PreviewMD, y qué lo renderiza

Todos los renderizadores de abajo viajan dentro de la app. Mientras se dibuja un documento no se descarga nada, no se contacta con ninguna CDN y no sale del dispositivo ninguna telemetría, y por eso Quick Look aparece al instante y por eso todo esto funciona en un avión.

Esta página la renderiza esa misma pila. Cambia arriba a Fuente y verás el Markdown que hay detrás de cualquier ejemplo.

Los módulos

Módulo Versión Qué hace
markdown-it 14.1.0 El analizador: CommonMark, más las extensiones de GitHub de abajo
KaTeX 0.16.22 Matemáticas compuestas, no fotografiadas
Mermaid 11.16.1 Diagramas dibujados a partir de texto
highlight.js 11.11.1 Resaltado de sintaxis, casi doscientos lenguajes
@vscode/markdown-it-katex 1.1.2 Encuentra $…$ y $$…$$ en el texto y se los pasa a KaTeX
markdown-it-task-lists 2.1.0 Las casillas - [x]
markdown-it-footnote 4.0.0 Notas al pie y sus enlaces de vuelta
markdown-it-emoji 2.0.2 Los :shortcodes:
markdown-it-front-matter 0.2.4 Front matter en YAML, oculto en vez de impreso
jsdiff + diff2html — La vista Diff y su resaltado a nivel de palabra
github-markdown-css — El estilo de la página, claro y oscuro

Cada uno lleva su propio aviso de licencia, reproducido palabra por palabra en la app bajo Ayuda ▸ Agradecimientos.

Matemáticas

KaTeX compone las fórmulas, así que se escalan, se seleccionan y se copian como texto en vez de llegar como una imagen borrosa. Las matemáticas en línea van entre dólares simples — la velocidad en cualquier punto de una órbita es v=μ(2/r−1/a)v = \sqrt{\mu(2/r - 1/a)} — y una fórmula en su propia línea va entre dólares dobles:

Δv=μr1(2r2r1+r2−1)\Delta v = \sqrt{\frac{\mu}{r_1}}\left(\sqrt{\frac{2r_2}{r_1+r_2}} - 1\right)

Las matrices, las sumas y las ecuaciones alineadas funcionan igual:

A=(abcd)∑n=1∞1n2=π26A = \begin{pmatrix} a & b \\ c & d \end{pmatrix} \qquad \sum_{n=1}^{\infty} \frac{1}{n^2} = \frac{\pi^2}{6}

Diagramas

Un bloque delimitado y marcado como mermaid se convierte en un dibujo. El texto sigue siendo la fuente de la verdad: cambias una línea, cambia la imagen, y el archivo sigue siendo un archivo de texto en el que tu control de versiones ve las diferencias.

graph LR
  A[Escribir] --> B[Vista previa]
  B --> C{¿Se ve bien?}
  C -- sí --> D[Exportar]
  C -- no --> A

Diagramas de secuencia, para cualquier cosa con ida y vuelta:

sequenceDiagram
  participant F as Finder
  participant Q as Quick Look
  participant P as PreviewMD
  F->>Q: barra espaciadora sobre README.md
  Q->>P: renderiza este archivo
  P-->>Q: la página renderizada
  Q-->>F: mostrada, sin abrir ninguna app

Y las proporciones, donde una tabla te dejaría la aritmética a ti:

pie showData
  title De qué está hecho un README
  "Prosa" : 55
  "Bloques de código" : 30
  "Tablas" : 10
  "Diagramas" : 5

Los diagramas de estados y de clases, los de Gantt y el resto del repertorio de Mermaid se dibujan igual.

Código

Los bloques delimitados los resalta highlight.js, que conoce casi doscientos lenguajes. El lenguaje se escribe justo después de la delimitación de apertura:

struct Entry: Comparable {
    let clock: UInt64
    let device: UUID

    static func < (a: Entry, b: Entry) -> Bool {
        // Los empates se deciden por el id del dispositivo, así el orden es el mismo en todas partes.
        (a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
    }
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
    """Delta-v total para una transferencia entre órbitas circulares."""
    first = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
    second = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
    return first + second

Un bloque sin lenguaje se queda como texto monoespaciado, y el código en línea no necesita ningún lenguaje.

Las extensiones de GitHub

Lo que GitHub añadió a Markdown y lo que, por tanto, un README da por hecho:

  • Listas de tareas, con las casillas dibujadas
  • Incluidas las que siguen abiertas
  • Tachado para lo que ya no vale
  • Notas al pie[1], numeradas y enlazadas de vuelta
  • Enlaces automáticos: https://previewmd.xfanta.com se convierte en enlace por sí solo
  • Emoji por código corto: 🚀 ✨ ✅

Note

Los bloques de aviso son una convención propia de GitHub, no forman parte de ninguna especificación de Markdown: una cita cuya primera línea nombra el tipo.

Warning

Hay cinco: Note, Tip, Important, Warning y Caution.


  1. Que acaban al final del documento, con una flecha de vuelta a donde estabas leyendo. ↩︎

Los más discretos

Front matter. Un bloque YAML en lo más alto del archivo, entre líneas ---, son metadatos para un generador de sitios estáticos, no algo que quisieras leer. Se analiza y se oculta, en vez de imprimirse como una tabla de jerigonza.

Imágenes. Las imágenes locales a las que apunta un documento se muestran, cargadas desde la carpeta en la que está el documento. Nada se descarga por la red, así que un documento con una ruta rota lo dice en vez de quedarse colgado.

Tablas. Tablas GFM normales, con barras verticales y la alineación tomada de los dos puntos de la fila separadora. Las anchas se desplazan en vez de romper la página.

Leer todo esto en tu Mac

PreviewMD renderiza todo lo de esta página en Quick Look, en su propia ventana y en la exportación a HTML y PDF — en Mac, iPad y iPhone, gratis.

La chuleta enumera cada marca con su resultado, y qué es Markdown cuenta de dónde viene el formato.