~/tilder/, fr/, Documentation/, Guide/, Premiers pas

getting started - installer tilder et construire un premier site

tilder tourne depuis son image Docker ou depuis une copie du dépôt avec Python 3.11 ou plus récent ; rien d'autre n'est nécessaire. Cette page copie le site de départ, un petit site bilingue avec son propre thème, le construit, le fait se reconstruire pendant que vous écrivez, et fait le tour de ce que la construction laisse dans public/.

Le dossier starter/ du dépôt est un site complet : une page d'accueil, un blog avec un article, une page 404, en anglais et en français, et un thème minimal sur les polices du système. Copiez-le et faites-en le vôtre :

git clone --branch v1.4.1 https://github.com/THOSTED/tilder
cp -r tilder/starter my-site
cd my-site

Sautez le clonage si vous l'avez déjà fait pour lancer tilder avec Python.

On y trouve les trois dossiers de tout projet : content/ (les pages et site.toml), theme/ (l'apparence) et assets/ (le logo). La page le projet les décrit un par un.

Le site de départ déclare deux langues. Pour un site dans une seule langue, supprimez content/site.fr.toml, tous les fichiers .fr.md et la ligne languages de content/site.toml.

Avec Docker, depuis my-site/ :

mkdir -p public
docker run --rm -u "$(id -u):$(id -g)" \
  -v "$PWD:/site" -v "$PWD/public:/out" \
  ghcr.io/thosted/tilder:1.4.1 \
  python3 -B /tilder/build.py --root /site --out /out

-u vous rend propriétaire de ce que la construction écrit ; créer public/ d'abord évite que Docker le crée au nom de root.

Avec Python, depuis my-site/, à côté de la copie tilder/ :

python3 ../tilder/build.py

tilder construit le dossier courant quand il contient un dossier content/, et écrit dans son public/. Depuis un autre endroit, nommez les deux : --root est le projet à construire, --out l'endroit où écrire le site.

python3 tilder/build.py --root my-site --out my-site/public

La construction affiche ce qu'elle a trouvé, puis chaque fichier écrit :

$ python3 ../tilder/build.py
languages: en (default), fr
types: event, member, page, post
collections: blog (post, 1 item), events (event, no folder), ...
[10:42:07] built /home/me/my-site/public: 404.html, ...

Une construction suivante n'écrit que ce qui a changé, et supprime du dossier de sortie tout fichier qu'elle ne produit plus : ce dossier appartient à tilder, n'y gardez rien d'autre.

Un problème dans le contenu arrête la construction, avec un message qui nomme le fichier et dit quoi faire ; le code de sortie est alors 1. Un avertissement, comme une image sans texte alternatif ou une description trop longue pour les moteurs de recherche, ne l'arrête pas. Tous les messages sont listés dans la référence de la ligne de commande.

--watch construit une fois, puis surveille le projet et reconstruit à chaque modification :

python3 ../tilder/build.py --watch

La commande par défaut de l'image est cette même surveillance, de /site vers /out :

docker run --rm -u "$(id -u):$(id -g)" \
  -v "$PWD:/site" -v "$PWD/public:/out" ghcr.io/thosted/tilder:1.4.1

Elle regarde content/, theme/ et assets/ chaque seconde. Une construction qui échoue garde la dernière sortie valable et attend la modification suivante. Une modification du générateur lui-même, ou des types Python d'un thème dans theme/types/, relance le processus pour charger le nouveau code.

Elle reconstruit aussi à minuit, sans aucune modification : la date de la construction décide quels événements sont à venir et lesquels sont passés, si bien qu'un événement rejoint la liste des événements passés le lendemain de sa date. Minuit est celui de la machine : dans un conteneur, UTC, sauf si la variable TZ en décide autrement.

Pour le parcourir, servez le dossier : les liens n'ont pas de .html, donc ouvrir les fichiers depuis le disque les casse, et la pile compose de la page déploiement les sert comme prévu. La construction a écrit :

Un site avec des événements reçoit aussi leur flux RSS et un fichier iCalendar. Rien de tout cela ne se modifie à la main, et rien n'est versionné : public/ est reconstruit à partir des sources à chaque fois.

• le projet
• la ligne de commande
• le déploiement