Ce que PreviewMD rend, et ce qui le rend
Chaque moteur de rendu ci-dessous est embarqué dans l’app. Rien n’est téléchargé pendant qu’un document se dessine, aucun CDN n’est contacté, aucune télémétrie ne quitte l’appareil — c’est pour ça que Coup d’œil apparaît instantanément et que tout cela marche en avion.
Cette page est rendue par la même pile. Passe en Source tout en haut pour voir le Markdown derrière n’importe quel exemple.
Les modules
| Module | Version | Ce qu’il fait |
|---|---|---|
| markdown-it | 14.1.0 | L’analyseur : CommonMark, plus les extensions GitHub ci-dessous |
| KaTeX | 0.16.22 | Les maths, composées plutôt que mises en image |
| Mermaid | 11.16.1 | Des diagrammes dessinés à partir de texte |
| highlight.js | 11.11.1 | La coloration syntaxique, près de deux cents langages |
| @vscode/markdown-it-katex | 1.1.2 | Repère $…$ et $$…$$ dans le texte et les passe à KaTeX |
| markdown-it-task-lists | 2.1.0 | Les cases - [x] |
| markdown-it-footnote | 4.0.0 | Les notes de bas de page et leurs liens de retour |
| markdown-it-emoji | 2.0.2 | Les :shortcodes: |
| markdown-it-front-matter | 0.2.4 | L’en-tête YAML, masqué au lieu d’être imprimé |
| jsdiff + diff2html | — | La vue Diff et son surlignage au mot près |
| github-markdown-css | — | Le style de la page, en clair et en sombre |
Chacun porte sa propre mention de licence, reproduite mot pour mot dans l’app sous Aide ▸ Remerciements.
Les maths
KaTeX compose les formules : elles se redimensionnent, se sélectionnent et se copient comme du texte au lieu d’arriver en image floue. Les maths en ligne se mettent entre simples dollars — la vitesse en tout point d’une orbite vaut — et une formule sur sa propre ligne entre doubles dollars :
Matrices, sommes et équations alignées marchent pareil :
Les diagrammes
Un bloc délimité marqué mermaid devient un dessin. Le texte reste la référence : change une ligne, l’image change, et le fichier est toujours un fichier texte que ta gestion de versions peut comparer.
graph LR
A[Écriture] --> B[Aperçu]
B --> C{Ça va ?}
C -- oui --> D[Export]
C -- non --> A
Les diagrammes de séquence, pour tout ce qui va et vient :
sequenceDiagram
participant F as Finder
participant Q as Coup d'œil
participant P as PreviewMD
F->>Q: barre d'espace sur README.md
Q->>P: rends ce fichier
P-->>Q: la page rendue
Q-->>F: affiché, aucune app lancée
Et les proportions, là où un tableau te laisserait faire l’arithmétique :
pie showData
title De quoi est fait un README
"Prose" : 55
"Blocs de code" : 30
"Tableaux" : 10
"Diagrammes" : 5
Les diagrammes d’états et de classes, les Gantt et tout le reste du répertoire de Mermaid se rendent de la même façon.
Le code
Les blocs délimités sont colorés par highlight.js, qui connaît près de deux cents langages. Le langage se note juste après la délimitation ouvrante :
struct Entry: Comparable {
let clock: UInt64
let device: UUID
static func < (a: Entry, b: Entry) -> Bool {
// L'égalité se tranche sur l'identifiant d'appareil, pour que l'ordre soit le même partout.
(a.clock, a.device.uuidString) < (b.clock, b.device.uuidString)
}
}
def hohmann(r1: float, r2: float, mu: float = 3.986e14) -> float:
"""Delta-v total pour un transfert entre orbites circulaires."""
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 bloc sans langage reste du texte à largeur fixe, et le code en ligne n’a besoin d’aucun langage.
Les extensions GitHub
Ce que GitHub a ajouté au Markdown, et ce qu’un README suppose donc :
- Les listes de tâches, avec les cases dessinées
- Y compris celles qui sont encore ouvertes
Le texte barrépour ce qui ne s’applique plus- Les notes de bas de page[1], numérotées et reliées en retour
- Les liens automatiques : https://previewmd.xfanta.com devient un lien tout seul
- Les emoji par raccourci : 🚀 ✨ ✅
Note
Les encarts d’alerte sont une convention propre à GitHub, absente de toute spécification Markdown — une citation dont la première ligne nomme le genre.
Warning
Il y en a cinq : Note, Tip, Important, Warning et Caution.
Qui atterrissent au bas du document, avec une flèche pour revenir là où tu lisais. ↩︎
Les plus discrètes
L’en-tête YAML. Un bloc YAML tout en haut d’un fichier, entre deux lignes ---, sert de métadonnées à un générateur de site statique — ce n’est pas fait pour être lu. Il est analysé et masqué plutôt qu’imprimé en tableau de charabia.
Les images. Les images locales auxquelles un document renvoie sont affichées, chargées depuis le dossier où il se trouve. Rien n’est récupéré sur le réseau, donc un document au chemin cassé le dit au lieu de rester bloqué.
Les tableaux. Des tableaux GFM ordinaires, à barres verticales, l’alignement venant des deux-points de la ligne de séparation. Les larges défilent au lieu de casser la page.
Lire tout ça sur ton Mac
PreviewMD rend tout ce qui est sur cette page dans Coup d’œil, dans sa propre fenêtre, et dans le HTML et le PDF exportés — sur Mac, iPad et iPhone, gratuitement.
L’aide-mémoire liste chaque marque avec son résultat, et ce qu’est le Markdown raconte d’où vient le format.