Cecil est distribué sous la forme d’un unique fichier exécutable, cecil.phar, qui fonctionne partout où PHP est installé.

Prérequis

• PHP 8.3+
• Extensions PHP : fileinfo, gd et mbstring

Vérifiez votre version de PHP et les extensions chargées :

php -v
php -m

Extensions optionnelles

Télécharger le PHAR

Téléchargez cecil.phar depuis votre terminal :

curl -LO https://cecil.app/cecil.phar

Puis exécutez-le avec PHP :

php cecil.phar --version

Installation globale

Installer Cecil globalement permet d’exécuter la commande cecil depuis n’importe quel dossier, au lieu de php cecil.phar.

macOS et Linux

Avec Homebrew :

brew install cecilapp/tap/cecil

Ou manuellement, en déplaçant le PHAR dans un dossier de votre PATH :

mv cecil.phar /usr/local/bin/cecil
chmod +x /usr/local/bin/cecil

Windows

Avec Scoop :

scoop install https://cecil.app/scoop/cecil.json

Ou manuellement :

1. Déplacez cecil.phar dans un dossier dédié tel que C:\bin
2. Renommez cecil.phar en cecil
3. Ajoutez ;C:\bin à votre variable d’environnement PATH
4. Créez un « wrapping batch script » à côté

PHIVE

Avec PHIVE (The PHAR Installation and Verification Environment) :

phive install cecil

Composer

Avec Composer :

composer global require cecil/cecil

Vérifier l’installation

cecil --version

Mise à jour

Mettez à jour Cecil vers la dernière version selon votre méthode d’installation :

# PHAR
php cecil.phar self-update
# Homebrew
brew upgrade cecilapp/tap/cecil
# Scoop
scoop update cecil
# PHIVE
phive update cecil
# Composer
composer global update cecil/cecil

La commande self-update (PHAR uniquement) accepte également les options suivantes :

• --rollback : revient à la version précédemment installée
• --stable : force la mise à jour vers la dernière version stable
• --preview : force la mise à jour vers la dernière version instable

Dépannage

command not found: cecil

Le dossier d’installation n’est pas dans votre PATH : ajoutez-le, ou exécutez Cecil avec php cecil.phar depuis le dossier contenant le PHAR.

Erreur de version ou d’extension PHP

Le PHP utilisé en ligne de commande peut différer de celui attendu (plusieurs versions installées) : vérifiez-le avec php -v et php --ini, puis activez les extensions manquantes dans le fichier php.ini chargé.

Diagnostiquer un site

Une fois un site créé, exécutez la commande doctor pour diagnostiquer sa configuration.

Arborescence du système de fichiers

Organisation des fichiers du projet.

<monsiteweb>
├─ pages
|  ├─ blog            <- Section
|  |  ├─ billet-1.md  <- Page dans Section
|  |  └─ billet-2.md
|  ├─ projets
|  |  └─ projet-a.md
|  └─ about.md        <- Page racine
├─ assets
|  ├─ styles.scss     <- Fichier d'asset
|  └─ logo.png
├─ static
|  └─ fichier.pdf     <- Fichier statique
└─ data
   └─ auteurs.yml     <- Collection de données

Arborescence du site généré

Résultat de la génération.

<monsiteweb>
└─ _site
   ├─ index.html               <- Page d'accueil générée
   ├─ blog/
   |  ├─ index.html            <- Liste des articles générée
   |  ├─ billet-1/index.html   <- Article de blog
   |  └─ billet-2/index.html
   ├─ projets/
   |  ├─ index.html            <- Liste des projets générée
   |  └─ projet-a/index.html   <- Projet individuel
   ├─ about/index.html         <- Page "À propos"
   ├─ styles.css
   ├─ logo.png
   └─ fichier.pdf

Routage basé sur les fichiers

Les fichiers Markdown du répertoire pages activent un routage basé sur les fichiers. Cela signifie que l’ajout, par exemple, de pages/mon-projet/projet-a.md le rendra accessible à l’URL /projet-a dans votre navigateur.

Fichier :
                   pages/mon-projet/projet-a.md
                        └───── filepath ──────┘
URL :
    ┌───── baseurl ─────┬─────── path ────────┐
     https://exemple.com/mon-projet/projet-a/index.html
                        └─ section ─┴─ slug ──┘

Créer un site web

Vous pouvez créer un nouveau site web en quelques minutes.

Suivez les étapes ci-dessous pour créer votre premier site web Cecil.

Prérequis

• PHP 8.3+
• Terminal (une compréhension de base du terminal)
• Éditeur de texte, comme VS Code et/ou Typora

1. Télécharger Cecil

Téléchargez cecil.phar depuis votre terminal:

curl -LO https://cecil.app/cecil.phar

Vous pouvez également télécharger Cecil manuellement, ou utiliser :

• Homebrew: brew install cecilapp/tap/cecil
• Scoop: scoop install https://cecil.app/scoop/cecil.json

2. Créer un nouveau site

Créez un répertoire pour le site Web (ex : <monsiteweb>), placez y cecil.phar, puis exécutez la commande new:site :

php cecil.phar new:site

3. Ajouter une page

Exécutez la commande new:page :

php cecil.phar new:page

Vous pouvez maintenant modifier la page nouvellement créée avec votre éditeur Markdown : <monsiteweb>/pages/<nouvelle-page>.md.

4. Vérifier l’aperçu

Exécutez la commande suivante pour créer un aperçu du site Web :

php cecil.phar serve

Naviguez ensuite sur http://localhost:8000.

5. Générer et déployer

Quand vous êtes satisfait du résultat, vous pouvez générer le site afin de le déployer sur le Web.

Exécutez la commande suivante pour générer le site :

php cecil.phar build

Vous pouvez maintenant copier le contenu du répertoire _site sur un serveur Web 🎉

Pour démarrer rapidement, utilisez l’un des kits de démarrage Cecil prêts à l’emploi :

• The Butler : starter blog prêt à publier.
• Links : alternative open source à Linktree.
• Photo Stream : flux photo auto-hébergé minimaliste.
• Statidocs : site de documentation prêt à l’emploi.