v0.1.0 Un thème de documentation pour Static Site Generator
Une documentation vraiment utilisable
Lucid suit le modèle « documentation page » de l'U.S. Web Design System : navigation latérale, sommaire de page et colonne de lecture limitée à 66 caractères. Chaque paire de couleurs est vérifiée au niveau WCAG AAA avant la construction du site.
Commencer Lire les notes d'accessibilité
Construisez en une commande
Lucid est un répertoire de Markdown et de gabarits. Aucune étape de compilation propre, aucun bundler, aucun framework à installer côté client.
terminal
ssg --config themes/lucid/ssg.toml
contenu 8 pages, 2 langues
sortie public/lucid
audit 0 constatCe que le thème apporte
Les choix de mise en page sont ceux que recommande l'U.S. Web Design System pour la documentation, et ceux qu'attendent les lecteurs de tout site sérieux.
-
Navigation latérale
La liste persistante des pages de la section, la page courante étant signalée par aria-current et non par la couleur seule.
-
Sommaire de la page
Les titres de la page en cours de lecture, pour parcourir une référence longue sans avoir à la faire défiler pour en deviner la forme.
-
Précédent et suivant
Une documentation se lit au moins une fois dans l'ordre. La pagination nomme la page voisine au lieu de pointer une flèche vers elle.
-
Deux thèmes de couleur
Clair et sombre, tous deux au niveau AAA. Sans JavaScript, le thème suit le système d'exploitation; le contrôle y revient toujours.
Une accessibilité mesurée, pas affirmée
Les promesses d'accessibilité ne coûtent rien. Celles-ci sont imposées par les contrôles du dépôt : une modification qui en casse une fait échouer la construction.
- 7:1
- Contraste minimal de chaque paire de texte, dans les deux thèmes — WCAG 1.4.6 Contraste amélioré, le seuil AAA.
- 44px
- Taille minimale de chaque cible interactive, conforme au critère AAA 2.5.5 plutôt qu'au minimum AA de 24px.
- 0 Ko
- JavaScript nécessaire à la lecture. Les scripts ajoutent le choix du thème et le menu mobile, rien d'autre.