DocPensieve
Guide
Ces pages se lisent dans l'ordre. Chacune part de ce que la précédente a mis en place.
Installation
Ce qu'il faut, et comment mettre en place un projet de documentation.
Premier site
Générer, servir, et comprendre ce qui a été produit.
Écrire des pages
Frontmatter, adresses, ordre du menu, liens et images.
Versions
Garder côte à côte la version en ligne et celle qui se prépare.
Thèmes
Habiller le site, et changer les classes sans toucher au HTML.
Déploiement
Publier le site, et garder les versions passées en ligne.
Migrer de la 0.3 vers la 0.4
Faire passer un projet de la 0.3 à la 0.4 — ce qui change tout seul, et ce qu'il vaut la peine d'activer.
Navigation
Le menu de la documentation, les liens de l'en-tête, et ce que les deux deviennent sur un téléphone.
Quand ça casse
Les pannes que cet outil produit vraiment, leur cause et leur remède — classées par le symptôme que vous voyez.
Langues
Publier la même version en plusieurs langues — les dossiers, les adresses, et ce qu'il advient d'une page que personne n'a traduite.
À savoir d'abord
Le site produit est entièrement statique. Chaque page est un fichier HTML complet, servi tel quel, accompagné d'une seule feuille de style. Rien n'est calculé du côté du lecteur.
Une conséquence à garder en tête tout du long : ce qui dépend du moment — une date, un compte à rebours — est figé à la génération, pas à la lecture. TimeTimer le dit explicitement, et une génération programmée suffit à le garder juste.