PreviewMD pro Mac, iPad a iPhone
Získat

Co PreviewMD vysází a co to vysází

Všechny vysázeče níž jsou součástí aplikace. Při kreslení dokumentu se nic nestahuje, žádná síť se neoslovuje a ze zařízení nic neodchází — proto je Quick Look okamžitý a proto tohle všechno funguje i v letadle.

Tuhle stránku sází tentýž stack. Přepni nahoře na Zdroj a uvidíš Markdown za kteroukoli ukázkou.

Moduly

Modul Verze Co dělá
markdown-it 14.1.0 Parser: CommonMark a k tomu rozšíření GitHubu níž
KaTeX 0.16.22 Matematika vysázená, ne vyfocená
Mermaid 11.16.1 Diagramy kreslené z textu
highlight.js 11.11.1 Zvýraznění syntaxe, téměř dvě stě jazyků
@vscode/markdown-it-katex 1.1.2 Najde v textu $…$ a $$…$$ a předá je KaTeXu
markdown-it-task-lists 2.1.0 Zaškrtávátka - [x]
markdown-it-footnote 4.0.0 Poznámky pod čarou i s odkazy zpátky
markdown-it-emoji 2.0.2 Zkratky :emoji:
markdown-it-front-matter 0.2.4 Hlavička v YAML — skrytá, ne vytištěná
jsdiff + diff2html — Zobrazení Rozdíl a zvýraznění po slovech
github-markdown-css — Vzhled stránky, světlý i tmavý

Každý z nich nese vlastní licenční text, doslova přetištěný v aplikaci pod Nápověda ▸ Poděkování.

Matematika

KaTeX vzorce sází, takže se dají zvětšovat, označit a zkopírovat jako text, místo aby přišly jako rozmazaný obrázek. Matematika v řádku je mezi jednoduchými dolary — rychlost v libovolném bodě dráhy je v=μ(2/r−1/a)v = \sqrt{\mu(2/r - 1/a)} — a vzorec na vlastním řádku mezi dvojitými:

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

Matice, sumy a zarovnané rovnice fungují stejně:

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}

Diagramy

Blok označený mermaid se promění v kresbu. Pravdou zůstává text: změníš řádek, změní se obrázek — a soubor je pořád textový, takže v něm verzovací systém vidí rozdíly.

graph LR
  A[Psaní] --> B[Náhled]
  B --> C{Vypadá dobře?}
  C -- ano --> D[Export]
  C -- ne --> A

Sekvenční diagramy na všechno, kde si dvě strany něco podávají:

sequenceDiagram
  participant F as Finder
  participant Q as Quick Look
  participant P as PreviewMD
  F->>Q: mezerník nad README.md
  Q->>P: vysázej tenhle soubor
  P-->>Q: vysázená stránka
  Q-->>F: zobrazeno, nic se nespustilo

A poměry, kde by tabulka nechala počítání na tobě:

pie showData
  title Z čeho se skládá README
  "Text" : 55
  "Bloky kódu" : 30
  "Tabulky" : 10
  "Diagramy" : 5

Stavové a třídní diagramy, ganttovky a zbytek repertoáru Mermaidu se kreslí stejně.

Kód

Ohraničené bloky zvýrazňuje highlight.js, který zná téměř dvě stě jazyků. Jazyk se píše hned za úvodní ohraničení:

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

    static func < (a: Entry, b: Entry) -> Bool {
        // Shoda se láme na id zařízení, aby pořadí bylo všude stejné.
        (a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
    }
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
    """Celková delta-v pro přechod mezi kruhovými drahami."""
    prvni = (mu / r1) ** 0.5 * ((2 * r2 / (r1 + r2)) ** 0.5 - 1)
    druhy = (mu / r2) ** 0.5 * (1 - (2 * r1 / (r1 + r2)) ** 0.5)
    return prvni + druhy

Blok bez jazyka zůstane prostým strojopisem a kód v řádku žádný jazyk nepotřebuje.

Rozšíření GitHubu

Co GitHub k Markdownu přidal — a co tedy README předpokládá:

  • Úkoly i s vykreslenými zaškrtávátky
  • Včetně těch, co ještě čekají
  • Přeškrtnutí pro to, co už neplatí
  • Poznámky pod čarou[1], číslované a provázané zpátky
  • Automatické odkazy: https://previewmd.xfanta.com se odkazem stane samo
  • Emoji podle zkratky: 🚀 ✨ ✅

Note

Zvýrazněné bloky jsou konvence GitHubu, ne součást žádné specifikace Markdownu — je to citace, jejíž první řádek pojmenuje druh.

Warning

Jsou pětery: Note, Tip, Important, Warning a Caution.


  1. Které skončí na konci dokumentu, se šipkou zpátky tam, kde jsi četl. ↩︎

Ti tišší

Hlavička v YAML. Blok mezi řádky --- úplně nahoře jsou metadata pro generátor webu, ne něco, co jsi chtěl číst. Rozebere se a schová, místo aby se vytiskl jako tabulka nesmyslů.

Obrázky. Místní obrázky, na které dokument ukazuje, se zobrazí — načtou se ze složky, kde dokument leží. Po síti se nic netahá, takže dokument s rozbitou cestou to řekne, místo aby čekal.

Tabulky. Obyčejné svislítkové tabulky z GFM, zarovnání podle dvojteček v oddělovacím řádku. Široké se dají odrolovat, místo aby rozbily stránku.

Jak si tohle přečíst na svém Macu

PreviewMD vysází všechno z téhle stránky v Quick Looku, ve vlastním okně i v exportu do HTML a PDF — na Macu, iPadu i iPhonu, zdarma.

Tahák vypisuje každou značku i s výsledkem a co je Markdown říká, odkud se formát vzal.