Fichier de configuration principal

blog_configuration.yaml est un document YAML à la racine du projet définissant les propriétés du blog, comme son titre, le nom de son auteur, ainsi que des détails fonctionnels comme le nombre de publications par pages ou l'ordre d'affichage de celles-ci.

Immédiatement après avoir créé votre blog, il s'agira sans doute du premier fichier que vous éditerez. Après avoir rempli ces champs, dont l'usage est détaillé ci-dessous, vous n'aurez normalement plus besoin d'y revenir.

blog_name

Sans surprise, il s'agit du titre de votre blog.

disable_threads

Empêche VenC de générer les fils de publications spécifiés dans une liste. Les noms de fils peuvent appartenir à des catégories ou à des archives. Ces noms sont listés en étant séparés par une virgule.

disable_archives

Empêche VenC de générer les fils de publications des archives. Ce champ est un booléen, fixé à False par défaut.

disable_chapters

Empêche VenC de générer les chapitres. Ce champ est un booléen, fixé à True par défaut.

disable_categories

Empêche VenC de générer les fils de publications des catégories. Ce champ est un booléen, fixé à False par défaut.

disable_single_entries

Empêche VenC de générer les publications individuelles. Ce champ est un booléen, fixé à False par défaut.

disable_main_thread

Empêche VenC de générer le fil principal de publication. Ce champ est un booléen, fixé à False par défaut.

disable_rss_feed

Empêche VenC de générer un flux RSS. Ce champ est un booléen, fixé à False par défaut.

disable_atom_feed

Empêche VenC de générer un flux Atom. Ce champ est un booléen, fixé à False par défaut.

text_editor

L'éditeur de texte choisi pour éditer une nouvelle publication du blog.

date_format

"%A %d. %B %Y" par défaut. Définit le format de date utilisé à l'intérieur du blog. Le format des dates est en fait le même que celui utilisé par Python. Pour en savoir plus sur ce format, rendez vous ici.

author_name

Le nom de l'administrateur ou l'auteur du blog.

blog_description

Un très court résumé de ce dont parle votre site.

blog_keywords

Les mots-clefs associés au site, séparés par une virgule.

author_description

Un court texte à propos de l'auteur du blog.

license

La licence appliquée au contenu de votre site.

blog_url

L'URL du blog. Peut être laissée vide, selon le thème utilisé.

ftp_host

Optionel. Il s'agit du nom d'hôte de votre serveur FTP, s'il existe.

blog_language

Définit la langue du site.

author_email

Votre adresse e-mail.

code_highlight_css_override

Génère à nouveau le code CSS créé par le module Pygments. Ce champ est un booléen, fixé à False par défaut. Attention si ce champ est fixé à True, à chaque exportation de votre blog, les anciens codes CSS créés par Pygments seront écrasés.

path

Il s'agit d'une variable contenant différents chemins, vous ne devriez normalement pas avoir besoin d'y toucher. La liste de ces chemins est détaillée ci-dessous.

ftp

Le chemin absolu du répertoire de destination sur votre serveur FTP.

entries_sub_folders

Le nom de sous-répertoire qui contiendra les publications individuelles.

categories_sub_folders

Le nom du sous-répertoire qui contiendra les catégories

index_file_name

"index{page_number}.html" par défaut. Spécifie le nom de fichier des pages d'un fil de publication. Devrait toujours contenir la variable {page_number}.

category_directory_name

"{category}" par défaut. Définit le répertoire où sera exporté le fil de publication de la catégorie courante. Ce champ devrait donc toujours contenir la variable {category}.

chapter_directory_name

"{chapter_name} par défaut. Définit les noms de répertoire où seront exportés les chapitres, s'il en existe. Ce champ devrait donc toujours contenir la variable {chapter_name}.

archives_directory_name

"%Y-%m" par défaut. Définit le format de date utilisé pour les noms de répertoires des archives. Le format des dates est en fait le même que celui utilisé par Python. Pour en savoir plus sur ce format, rendez vous ici.

entry_file_name

"entry{entry_id}.html" par défaut. Définit le nom de fichier d'une publication unique.

rss_file_name

"rss.xml" par défaut. Définit le nom de fichier du flux RSS.

atom_file_name

"atom.xml" par défaut. Définit le nom de fichier du flux Atom.

entries_per_pages

10 par défaut. Définit le nombre de publications par page.

columns

1 par défaut. Ce champ définit le nombre de colonnes dans une page.

feed_lenght

5 par défaut. Définit le nombre de publications à afficher dans le flux RSS.

reverse_thread_order

Ce champ est un booléen, fixé à True par défaut. Définit l'ordre de publication. Du plus récent au plus ancien (True), ou l'inverse (False).

markup_language

Ce champ spécifie le langage de balisage par défaut utilisé dans toutes les publications. Cette valeur peut cependant être localement écrasée dans l'entête d'une publication.

Les valeurs possibles de ce champ sont :

  • Markdown
  • reStructuredText
  • none

path_encoding

Permet de spécifier l'encodage des chemins générés par VenC. Utile dans certains cas, quand un ou plusieurs liens internes contiennent des accents ou des caractères spéciaux mal supportés par le serveur hôte. Ce champ n'a pas de valeur par défaut.

server_port

Spécifie le port du server HTTP local. Ce champ est fixé à 8888 par défaut.

sort_by

Pour être ordonnées, les publications sont généralement évaluées selon la valeur de leur identifiant. C'est pourquoi la valeur de ce champ est 'id' par défaut. Il est possible de spécifier le nom d'une autre propriété pour les publications.

Les valeurs possibles sont :

  • authors
  • date
  • filename
  • formatted_date
  • id
  • tags
  • title

Vous pouvez également spécifier le nom d'une métadonnée définie manuellement dans l'entête de vos publications.

enable_jsonld

Active la création de fichier JSON-LD pour le référencement à l'aide des technique du web sémantique. Ce champ est un booléen qui vaut False par défaut. Selon la taille de votre blog, ces fichiers peuvent vite prendre de la place.

enable_jsonp

Active la création de fichier JSON-P contenant des données jsonld pour le moteur de recherche décentralisé côté client. Il s'agit d'une fonctionnalité expérimental. Ce champ est un booléen qui vaut False par défaut. Selon la taille de votre blog, ces fichiers peuvent vite prendre de la place.