Mise en route

Statidocs est un starter de documentation, construit avec le générateur de site statique Cecil et son thème Docs.

Créer un nouveau projet

La façon la plus simple de créer un nouveau projet Statidocs est d’utiliser Composer :

composer create-project cecil/statidocs --ask

Démarrer le serveur local

En local, le serveur intégré de Cecil vous permet de prévisualiser votre travail et rafraîchit automatiquement votre navigateur lorsque vous faites des modifications.

Dans le répertoire de votre projet, lancez la commande suivante pour démarrer le serveur local :

php cecil.phar serve

Un message indiquant l’URL de la prévisualisation locale s’affiche dans votre terminal. Ouvrez cette URL (http://localhost:8000 par défaut) pour parcourir votre documentation.

Ajouter des pages

Formats de fichiers

Statidocs prend en charge la rédaction de contenu en Markdown sans aucune configuration. Vous pouvez étendre les capacités par défaut en activant les options Markdown de Cecil.

Organiser les pages

Ajoutez de nouvelles pages à votre site en créant des fichiers .md dans pages/docs/. Utilisez des sous-répertoires pour regrouper les pages : chaque sous-répertoire contenant un fichier index.md devient un groupe repliable dans la barre latérale, quelle que soit sa profondeur.

Par exemple, la structure de fichiers suivante génère les pages /docs/getting-started/, /docs/guides/i18n/ et /docs/guides/advanced/customization/ :

<my-project>
└─ pages
   └─ docs
      ├─ 1-Getting started.md
      └─ guides
         ├─ index.md
         ├─ 2-i18n.md
         └─ advanced
            ├─ index.md
            └─ 1-customization.md

Les pages sont triées par weight (poids) : utilisez un préfixe numérique dans le nom du fichier (par exemple 1-) ou la variable de front matter weight.

Front matter

Toutes les pages utilisent des variables de front matter pour contrôler leur affichage :

---
title: Hello world
description: This is a page description.
---

Consultez la référence du front matter pour la liste complète des variables.

Générer et déployer

Lorsque vous êtes prêt à publier, générez le site statique dans le répertoire _site/ :

php cecil.phar build

Envoyez ensuite le contenu de _site/ sur n’importe quel hébergeur de sites statiques (Netlify, Vercel, GitHub Pages, etc.). Consultez la documentation de déploiement de Cecil pour plus de détails.

Mettre à jour Statidocs

Statidocs est construit sur le thème Cecil Docs. Vous pouvez le mettre à jour, ainsi que les autres thèmes Cecil, en lançant la commande suivante dans votre terminal :

composer update

Mettez à jour Cecil lui-même avec sa commande self-update :

php cecil.phar self-update