Documentation du Crieur

Pré-requis

Les pré-requis pour pouvoir utiliser le Crieur sont les suivants :

1. Avoir accès à Stylo et savoir structurer des articles et des corpus dessus, avec des métadonnées spécifiques ;
2. Installer uv, un gestionnaire de paquets Python - vous trouverez des indications pour l'installer ici ;
3. Disposer d'un terminal pour saisir des lignes de commande (et ne pas en avoir peur !) et/ou d'un dépôt Git en ligne au travers duquel générer et déployer votre site avec le Crieur.

Sur Stylo

La première étape va être de créer des articles et des corpus Stylo. Ces derniers correspondent à des "dossiers" ou "numéros" pour votre site. Les articles doivent être créés avec les métadonnées suivantes :

• Langue de l'article
• Date de publication
• Titre
• Auteur·ice·s
• Résumé (optionnel)
• Mots-clés (optionnels)

Une fois les articles structurés sur Stylo, vous devez ensuite les placer dans un corpus, qui correspondra au "dossier" ou "numéro" contenant vos articles. Sur la page de gestion des corpus sur Stylo, ajoutez les articles dans un ou plusieurs corpus, puis déterminez l'ordre d'affichage des articles dans ce corpus manuellement au travers d'un "glisser-déposer". Votre dossier prendra comme titre le nom que vous avez donné à votre corpus, ou alors la valeur à la métadonnée de corpus "title", si vous la spécifiez.

Pour prendre vos corpus comme sources pour le Crieur, il vous faut récupérer les identifiants de ceux-ci (par exemple 691dd81c6ddf3e0028foobar et 691dde946ddf3e002bazquux). Pour cela, appuyez sur l'option à trois points à droite sur la page de gestion des corpus puis sur "copier l'identifiant".

Sur la ligne de commande et en local

Ouvrez un terminal, créez un dossier dédié à votre site et placez-vous dedans :

mkdir mon-site
cd mon-site

En ayant bien UV installé (voir plus haut), tapez la commande suivante pour générer un fichier de configuration pour votre site Crieur :

uv run --with crieur crieur init

Cela va créer un fichier de configuration site.toml dans votre dossier, que vous pourrez ensuite modifier pour votre site, en commençant par l'inscription des identifiants de vos corpus sur Stylo. Vous pouvez ensuite donner un titre à votre site (par défaut "Crieur") et ajouter les options en commentaires qui vous sont pertinentes. Nous vous recommandons particulièrement d'activer l'option force = true en enlevant le # en début de ligne, afin que votre site puisse être mis-à-jour selon les modifications de vos articles dans Stylo (en permettant le remplacement des anciennes versions par les nouvelles). Un ensemble d'autres options sont documentées dans ce fichier de configuration, pour lesquelles vous trouverez davantage de détail dans cette documentation en ligne.

Une fois les options de votre site configurées (vous pourrez toujours revenir sur ces options et les enrichir ultérieurement), vous pouvez construire votre site au travers de cette commande, qui va appeler votre fichier de configuration :

uv run --with crieur crieur build site.toml

C'est à cette étape que des erreurs peuvent remonter, par exemple le manque de métadonnées obligatoires sur Stylo, des corpus vides ou autres. Si ce n'est pas le cas, votre site devrait être désormais généré, avec ses pages publiques dans public/ et ses fichiers sources de Stylo dans sources/, extraites d'un dossier .zip téléchargé depuis l'export de Stylo. Le dossier public/ contient l'intégralité de votre site que vous pouvez déposer chez un hébergeur web afin de rendre vos productions accessibles à toutes et tous.

Pour visualiser votre site en local sur votre machine, faîtes cette commande :

uv run --with crieur crieur serve

Vous devriez avoir ceci qui s'affiche :

Serving HTML book from `./public` to http://127.0.0.1:8000
Serving HTTP on :: port 8000 (http://[::]:8000/) ...

Vous pouvez alors aller sur http://127.0.0.1:8000 au travers du navigateur de votre choix et vous devriez voir votre site.

Pour reprendre la main sur votre terminal, vous devez taper simultanément ctrl+c.

Et voilà ! Vous pouvez maintenant passer à la configuration avancée, par exemple pour adapter le thème de votre site.