Fox – Utilisation et Commandes
Utilisation
La commande `fox` se base sur le dossier dans lequel elle a été exécutée pour récupérer les informations nécessaires à son fonctionnement.
Un projet basique aura la forme suivante :
Dans cet exemple, nous avons donc plusieurs dossiers :
- Le dossier `content` contiendra les fichiers au format Gemini permettant de générer à la fois la capsule gemini et le site web.
- Le sous-dossier `content/articles` contiendra la liste des fichiers utilisés lors de la génération des flux Atom et RSS.
- Le dossier `template` (qui est facultatif), contiendra les fichiers utilisés pour générer le site web et les flux Atom et RSS.
Lors du lancement de la commande `fox` à la racine du projet, un dossier `output` sera créé avec un sous-dossier pour la capsule gemini et un autre pour le site web.
Blog
Il est possible d’avoir un système de blog en définisant un sous-dossier `articles`. Les fichiers contenus dans ce sous-dossier seront utilisés pour définir les flux Atom et RSS.
Arguments
La commande `fox` peut être personnalisée via un ensemble d’arguments.
Dossiers
- `--content=FOLDER`, le dossier contenant les fichiers sources au format Gemini.
- `--output=FOLDER`, le dossier dans lequel seront stockés les fichiers générés.
- `--template=FOLDER`, le dossier utilisé pour récupérer les templates de génération HTML.
Génération
- `--base-url=URL`, l’URL utilisée lors de la génération du site web.
- `--gemini-url=URL`, l’URL utilisée lors de la génération de la capsule. Par défaut, elle utilisera la valeur de `--base-url` en remplaçant le protocole par `gemini://`.
- `--locale=LANG`, la langue utilisée par le site. Par défaut, elle utilisera la valeur de la variable d’environnement `LC_ALL`.
- `--atom` / `--no-atom`, active ou désactive la génération du flux Atom.
- `--rss` / `--no-rss`, active ou désactive la génération du flux RSS.
Template
- `--html-colors=COLORS`, la liste de 4 couleurs (au format hexadécimal et séparés par des virgules) utilisées par le template de base.
- `--pygments-style=THEME`, le nom du thème utilisé pour la colorisation des balises de code. Le module `pygments` doit être présent pour que ça soit utilisé, sinon cette option est ignorée.
Métadonnées
- `--author=AUTHOR`, le nom de l’aut·eur·rice du projet.
- `--datetime-csv=FILE`, le fichier utilisé pour obtenir la date de publication des articles.
- `--description=TEXT`, la description du projet.
- `--keywords=TEXT`, les mots-clés (séparés par des virgules) liés au projet.
- `--title=TEXT`, le titre du projet.
- `--year=TEXT`, l’année de dernière activité du projet.
Options
- `--debug`, active l’affichage des messages de débugage.
- `--force`, force la génération du dossier de sortie, même si celui-ci existe déjà.
–––
Liens permanents :