Aller au contenu
  1. Documentation/

Front Matter

Documentation - Cet article fait partie d'une série.
Partie 7: Cet article

En plus des paramètres front matter Hugo par défaut, Blowfish ajoute un certain nombre d’options supplémentaires pour personnaliser la présentation des articles individuels. Tous les paramètres front matter du thème disponibles sont listés ci-dessous.

Les valeurs par défaut des paramètres front matter sont héritées de la configuration de base du thème, vous n’avez donc besoin de spécifier ces paramètres dans votre front matter que lorsque vous souhaitez remplacer la valeur par défaut.

NomDéfautDescription
titleNon définiLe nom de l’article.
descriptionNon définiLa description textuelle de l’article. Elle est utilisée dans les métadonnées HTML.
externalUrlNon définiSi cet article est publié sur un site tiers, l’URL vers cet article. Fournir une URL empêchera la génération d’une page de contenu et toutes les références à cet article pointeront directement vers le site tiers.
editURLarticle.editURLLorsque showEdit est actif, l’URL du lien d’édition.
editAppendPatharticle.editAppendPathLorsque showEdit est actif, si le chemin vers l’article actuel doit être ajouté à l’URL définie dans editURL.
groupByYearlist.groupByYearSi les articles sont groupés par année sur les pages de liste.
menuNon définiLorsqu’une valeur est fournie, un lien vers cet article apparaîtra dans les menus nommés. Les valeurs valides sont main ou footer.
robotsNon définiChaîne indiquant comment les robots doivent traiter cet article. Si défini, il sera affiché dans l’en-tête de la page. Consultez la documentation Google pour les valeurs valides.
sharingLinksarticle.sharingLinksQuels liens de partage afficher à la fin de cet article. Lorsque non fourni ou défini sur false, aucun lien ne sera affiché.
showAuthorarticle.showAuthorSi la boîte auteur pour l’auteur par défaut est affichée dans le pied de page de l’article.
showAuthorBottomarticle.showAuthorBottomLes boîtes auteur sont affichées en bas de chaque page au lieu du haut.
authorsNon définiTableau de valeurs pour les auteurs, si défini, il remplace les paramètres showAuthor pour la page ou le site. Utilisé pour la fonctionnalité de multiples auteurs, consultez cette page pour plus de détails sur la configuration.
showAuthorsBadgesarticle.showAuthorsBadgesSi les taxonomies authors sont affichées dans l’en-tête de l’article ou de la liste. Cela nécessite la configuration de multiple authors et de la taxonomie authors. Consultez cette page pour plus de détails.
featureimageNon définiLien pour l’image mise en avant
featureimagecaptionNon définiLégende pour l’image mise en avant. Affichée uniquement dans le heroStyle big
showHeroarticle.showHeroSi l’image vignette sera affichée comme image hero dans la page de l’article.
heroStylearticle.heroStyleStyle d’affichage de l’image hero, les options valides sont : basic, big, background, thumbAndBackground.
imagePositionNon définiDéfinit la position de l’image mise en avant en utilisant l’attribut object-position. Les valeurs valides sont comme spécifié dans la documentation MDN.
showBreadcrumbsarticle.showBreadcrumbs ou list.showBreadcrumbsSi les fils d’Ariane sont affichés dans l’en-tête de l’article ou de la liste.
showDatearticle.showDateSi la date de l’article est affichée. La date est définie avec le paramètre date.
showDateUpdatedarticle.showDateUpdatedSi la date de mise à jour de l’article est affichée. La date est définie avec le paramètre lastmod.
showEditarticle.showEditSi le lien pour éditer le contenu de l’article doit être affiché.
showHeadingAnchorsarticle.showHeadingAnchorsSi les liens d’ancrage des titres sont affichés à côté des titres dans cet article.
showPaginationarticle.showPaginationSi les liens article suivant/précédent sont affichés dans le pied de page de l’article.
invertPaginationarticle.invertPaginationSi la direction des liens article suivant/précédent doit être inversée.
showReadingTimearticle.showReadingTimeSi le temps de lecture de l’article est affiché.
showTaxonomiesarticle.showTaxonomiesSi les taxonomies liées à cet article sont affichées.
showTableOfContentsarticle.showTableOfContentsSi la table des matières est affichée sur cet article.
showWordCountarticle.showWordCountSi le nombre de mots de l’article est affiché.
showCommentsarticle.showCommentsSi le partial commentaires est inclus après le pied de page de l’article.
showSummarylist.showSummarySi le résumé de l’article doit être affiché sur les pages de liste.
showViewsarticle.showViewsSi les vues de l’article doivent être affichées dans les listes et la vue détaillée. Cela nécessite une intégration Firebase. Consultez cette page pour un guide sur l’intégration de Firebase.
showLikesarticle.showLikesSi les likes de l’article doivent être affichés dans les listes et la vue détaillée. Cela nécessite une intégration Firebase. Consultez cette page pour un guide sur l’intégration de Firebase.
seriesOpenedarticle.seriesOpenedSi le module de série sera affiché ouvert par défaut ou non.
seriesNon définiTableau des séries auxquelles l’article appartient, nous recommandons d’utiliser une seule série par article.
series_orderNon définiNuméro de l’article dans la série.
summaryGénéré automatiquement avec summaryLength (voir configuration du site)Lorsque showSummary est activé, c’est la chaîne Markdown à utiliser comme résumé pour cet article.
xmltrue sauf exclusion par sitemap.excludedKindsSi cet article est inclus dans le fichier /sitemap.xml généré.
excludeFromSearchfalseSi cet article doit être exclu du sitemap et de l’index de recherche. Lorsque true, la page n’apparaîtra pas dans sitemap.xml ou index.json.
layoutBackgroundBlurtrueFait flouter l’image d’arrière-plan dans le heroStyle background avec le défilement
layoutBackgroundHeaderSpacetrueAjoute de l’espace entre l’en-tête et le corps.
Documentation - Cet article fait partie d'une série.
Partie 7: Cet article

Articles connexes