Installer

Avant de commencer

Il vous faut Node.jsL'environnement JavaScript sur lequel tourne DocPensieve — version 22 ou plus récente. et un terminal. Rien d'autre : le thème est livré avec l'outil.

À vous

npx docpensieve init mon-cours

La commande pose quelques questions, puis écrit le projet.

Ce qu'il écrit

• mon-cours

  • docpensieve.config.mjs — tous les réglages du site
  • docs

    • v1.0

      • index.md — la page d'accueil
      • 01-guide — une première section, avec une page d'exemple
      • 99-docpensieve — la documentation de l'outil, à supprimer ensuite
  • .gitignore — garde dist/ et node_modules/ hors du dépôt

Ouvrez la configuration

C'est le fichier sur lequel vous reviendrez à chaque module de ce cours. Tous les réglages y sont écrits, la plupart en commentaire — c'est un menu autant qu'une configuration :

/** @type {import('@docpensieve/core').DocPensieveConfig} */
export default {
  // Nom affiché dans l'en-tête, dans les titres de page et dans les données
  // structurées.
  projectName: 'My documentation',

  // Adresse publique du site. Elle alimente les liens canoniques et les
  // données structurées, et son chemin donne le préfixe de déploiement.
  // siteUrl: 'https://example.com/my-project',

  versions: [
    {
      slug: 'v1.0', // segment d'adresse, et nom de la branche de la version
      name: '1.0', // libellé dans le sélecteur de version
      folder: 'docs/v1.0',
      current: true,
    },
  ],
};

Le commentaire en tête du fichier n'est pas décoratif : c'est lui qui donne à votre éditeur le nom et la forme de chaque champ, si bien qu'une faute de frappe se voit pendant que vous tapez plutôt qu'à la génération suivante.

Vérifiez par vous-même