Les Collections !

Les collections dans Jekyll 2.0

Tout dans votre site Jekyll n’est pas un post ou une page. Vous voudrez peut-être documenter différentes méthodes dans votre projet OpenSource, l’annuaire des membres d’une équipe ou une liste d’albums de musique. Les collections vous permettent de définir un nouveau type de document qui se comporte comme le font normalement les Pages ou les Posts, mais elles disposent aussi de leurs propres propriétés uniques et d’un espace-nom.

Utiliser les Collections

Étape 1 : Dire à Jekyll de lire dans votre collection

Ajoutez ce qui suit au fichier _config.yml de votre site, en remplaçant ma_collection avec le nom de votre collection :

collections:
- ma_collection

Vous pouvez facultativement spécifier les métadonnées de votre collection dans votre configuration :

collections:
  ma_collection:
    foo: bar

Étape 2 : Ajouter votre Contenu

Créez un dossier correspondant (par ex. /_ma_collection) et ajoutez-y des documents.

Le front-matter YAML est lu comme de la data s’il existe, si non, alors tout est simplement placé dans l’attribut content du Document.

Note : le répertoire doit être nommé de la même manière que la collection que vous avez définie dans votre fichier config.yml, en le faisant précéder du caractère_.

Étape 3 : En option, restituez vos documents de votre collection en fichiers indépendants

Si vous voulez que Jekyll crée une version publique de chaque document dans votre collection, réglez la clé output sur true dans vos métadonnées de collection à l’intérieur de votre fichier _config.yml:

collections:
  ma_collection:
    output: true

Ceci produira un fichier pour chaque document dans la collection. Par exemple, si vous avez _ma_collection/un_sous_rep/un_doc.md, il sera restitué en utilisant Liquid et le convertisseur Markdown de votre choix, et écrit vers <dest>/ma_collection/un_sous_rep/un_doc.html.

Tout comme pour les posts avec des Permaliens, l’URL du document peut se personnaliser en réglant une métdonnée permalink à la collection :

collections:
  ma_collection:
    output: true
    permalink: /awesome/:path/

Par exemple, si vous avez _ma_collection/un_sousrep/un_doc.md, il sera écrit vers <dest>/awesome/un_sousrep/un_doc/index.html.

Variable Description

collection

Étiquette de la collection

path

Chemin vers le document relatif au répertoire de la collection

output_ext

Extension du fichier produit

Attributs Liquid

Collections

Chaque collection est accesible via la variable Liquid site. Par exemple, si vous voulez accéder à la collection albums trouvée dans _albums, vous utiliseriez site.albums. Chaque collection est en elle-même une série de documents (par ex. site.albums est une série de documents, tout comme site.pages et site.posts). Voir ci-dessous pour savoir comment accéder aux attributs de ces documents.

Les collections sont aussi disponibles sous site.collections, avec la métadonnée que vous avez spécifiée dans votre _config.yml (si présent) et l’information qui suit :

Variable Description

label

Le nom de votre collection, par ex. ma_collection.

docs

Une série de documents.

relative_directory

Le chemin vers le répertoire source de la collection, relatif au site source.

directory

Le chemin complet vers le répertoire source de la collection.

output

Si les documments de la collection seront produits sous forme de fichiers individuels.

Documents

En plus de n’importe quel FrontMatter YAML fourni dans le fichier correspondant du document, chaque document a les attributs suivants :

Variable Description

content

Le contenu (unrendered) du document. Si aucun FrontMatter YAML n'est utilisé, alors ceci est tous les contenus du fichier après la fin `---` du FrontMatter.

output

L'output restitué du document, basé sur le content.

path

Le chemin complet vers le fichier source du document.

relative_path

Le chemin vers le fichier source du document relatif au site source.

url

L'URL de la collection rendue. Le fichier est uniquement écrit vers la destination quand le nom de la collection à laquelle il appartient est inclus dans la clé render dans le fichier de configuration du site.

“Les Collections !” a été mise à jour le :
Améliorer cette page