Une première génération

Trois commandes

Ce qui sort

• dist

  • index.html — envoie le lecteur vers la version courante
  • versions.json — les versions, pour le sélecteur
  • versions

    • v1.0

      • index.html — la page d'accueil
      • guide — un dossier par page, chacun avec son index.html
      • assets — la feuille de style, les images, l'index de recherche
      • search — la seule page qui porte un script

Chaque page est un fichier complet, servi tel quel. Une page est un dossier qui contient un index.html, ce qui lui donne une adresse terminée par une barre oblique et ne demande aucune règle au serveur. La feuille de styleLa seule feuille du site, compilée depuis les classes qu'emploient les pages. suit ; aucun script ne suit.

Quand quelque chose ne va pas

build s'arrête sur ce qu'il ne peut pas faire — un fichier manquant, un composant mal employé — et le nomme. Il ne dit rien d'un lien qui vise une page que vous avez renommée : cette page compilait parfaitement, elle n'est simplement plus là.

npx docpensieve check

Pendant que vous écrivez

npx docpensieve dev

Il sert le site et régénère à chaque enregistrement — y compris quand vous changez la configuration ou un fichier du dossier theme/. Laissez-le tourner dans un second terminal : la boucle entre écrire une phrase et la voir est ce qui fait qu'une documentation s'écrit.

Bravo

Vous avez terminé Premiers pas. Le module suivant montre comment organiser les pages et employer les composants.