Un générateur de site statique qui casse des briques. VenC est tellement rapide qu'il enfreint le principe de causalité et produit de l'énergie surunitaire ! |
Une publication est un fichier dans lequel vous allez pouvoir rédiger votre contenu. Cela peut-être un billet d'humeur ou d'opinion, un article de fond, une galerie d'images, etc. Pour faciliter l'édition de votre blog avec VenC, vous êtes fortement encouragé à utiliser des templates.
Le nom de fichier d'une publication est formaté de la façon suivante :
<id>__<mois>-<jour>-<année>-<heure>-<minute>__<titre>
Une publication contient une première partie au format YAML contenant les métadonnées de la publication, puis une seconde au format Markdown (format par défaut) qui contiendra la publication à proprement parler. Cette seconde partie est elle-même scindée en deux. L'une contiendra la prévisualisation de la publication, et l'autre son véritable contenu. Vous pouvez évidemment contrôler l'affichage de la prévisualisation et de la publication en fonction de votre template/thème de blog.
Une publication vierge se présente de la façon suivante:
authors: - '' categories: - '' title: ---VENC-BEGIN-PREVIEW--- ---VENC-END-PREVIEW---
Il y a donc quatre champs qu'il est possible de compléter.
C'est la liste des auteurs de la publication, séparés par une virgule. Par exemple : Denis Salem, Benjamin Bayard, Richard Stallman.
C'est la liste des catégories de la publication au format YAML. Comme ces catégories peuvent contenir des sous-catégories, les listes peuvent être imbriquées. Par exemple :
categories: - Libre: - GNU/Linux: - Gentoo - LibreOffice - Open-source: - Android
C'est le nom de votre publication, tel que vous l'avez défini au moment de créer la publication avec la commande :
venc -ne "titre de la publication"
Il est également possible de rajouter librement des champs optionnels. Il y a cependant deux champs réservés :
Indique à quel chapitre correspond la publication. La convention qu'utilise VenC pour reconnaître les chapitres est la suivante : chaque chapitre et chaque sous-partie sont numérotés, et séparés par un point. Quelques exemples pour aider à visualiser le truc :
'2'
: indique que la publication correspond au chapitre deux.'1.2'
: indique que la publication correspond au premier chapitre, sous-partie deux.'3.3.5'
: indique que la publication correspond au troisième chapitre, troisième sous-partie, cinquième sous-partie de la partie parente.Important : le champ chapter
doit explicitement être une chaîne
de caractères. Pour ce faire, l'index du chapitre doit être entre guillemets.
Il est possible de spécifier un langage de balisage qui sera utilisé pour la publication courante, en lieu et place du langage défini dans le fichier de configuration du blog.
VenC supporte trois langages de balisage :
Markdown
: qui est le langage par défaut.reStructuredText
: un peu plus complet et puissant que Markdown.asciidoc
: un peu plus complet et puissant que Markdown.none
: le langage de balisage est désactivé. Permet d'incorporer
du HTML et du CSS dans une publication.