Mise en route

Statidocs est un puissant démarreur de documentation, construit par le générateur de sites statiques Cecil.

Créer un nouveau projet

Le moyen le plus simple de créer un nouveau projet Statidocs consiste à utiliser Composer :

composer create-project cecil/statidocs mon-projet

Démarrer le serveur local

Quand vous travaillez localement, le serveur intégré à Cecil vous permet de prévisualiser votre travail et il rafraichit automatiquement votre navigateur lorsque vous effectuez une modification.

Au sein de votre projet, lancez la commande suivante pour démarrer le serveur local :

php cecil.phar serve

Cela va afficher un message dans votre terminal avec l’URL de votre aperçu local. Ouvrez cette URL (http://localhost:8000 par défaut) pour commencer à parcourir votre documentation.

Ajouter des articles

Formats de fichier

Statidocs supporte la rédaction de contenu au format Markdown sans paramétrage particulier. Vous pouvez étendre les capacités en activant les options Markdown de Cecil.

Ajouter des pages

Ajoutez de nouvelles pages à votre site en créant des fichiers .md dans pages/docs/. Utilisez un niveau de sous-dossiers pour organiser vos fichiers et un préfixe numérique pour les trier.

Par exemple, la structure de fichiers suivante va générer les pages au niveau de domain.tld/docs/mise-en-route et de domain.tld/docs/guides/i18n :

<monsite>
└─ pages
   └─ docs
      ├─ guides
      |  └─ 2-i18n.md
      └─ 1-Mise en route.md

Front matter

Toutes les pages utilisent les variables du front matter afin de contrôler la manière dont elles apparaissent :

---
title: Salut le monde
description: Ceci est une description de page.
---

Pour en savoir plus, consultez la documentation de Cecil concernant le front matter.

Mise à jour de Statidocs

Statidocs est construit sur le thème Cecil docs. Vous pouvez le mettre à jour ainsi que d'autres thèmes Cecil en exécutant la commande suivante dans votre terminal :

composer update