Table des Matières

Usage

Créez votre markdown comme vous le feriez normalement avec les titres appropriés. Voici un exemple de contenu :

<!-- Votre front matter en place ici -->

## Introduction

One morning, when Gregor Samsa woke from troubled dreams, he found himself transformed in his bed into a horrible vermin.

## Mon Titre

He lay on his armour-like back, and if he lifted his head a little he could see his brown belly, slightly domed and divided by arches into stiff sections. The bedding was hardly able to cover it and seemed ready to slide off any moment.

### Mon Sous-Titre

A collection of textile samples lay spread out on the table - Samsa was a travelling salesman - and above it there hung a picture that he had recently cut out of an illustrated magazine and housed in a nice, gilded frame. It showed a lady fitted out with a fur hat and fur boa who sat upright, raising a heavy fur muff that covered the whole of her lower arm towards the viewer. Gregor then turned to look out the window at the dull weather. Drops

Hugo prendra ce Markdown et créera une table des matières à partir de ## Introduction,## Mon Titre et ### Mon Sous-Titre, puis le stockera dans la variable de page.TableOfContents.

Les outputs des variables intégrées .TableOfContents produisent un élément <nav id="TableOfContents"> avec un enfant <ul>, dont les éléments <li> de l’enfant commencent par n’importe quel <h1>s (c’est-à-dire en markdown #) dans votre contenu.

Exemple de Modèle : TDM Basique

Voici un exemple d’un modèle très basique de modèle de page unique :

{{ define "main" }}
<main>
    <article>
    <header>
        <h1>{{ .Title }}</h1>
    </header>
        {{ .Content }}
    </article>
    <aside>
        {{ .TableOfContents }}
    </aside>
</main>
{{ end }}

Exemple de Modèle : TDM Partielle

Voici un modèle partiel qui ajoute un peu plus de logique pour le contrôle au niveau de la page sur votre table des matières. Il suppose que vous utilisez un champ toc dans le front matter de votre contenu qui, à moins que ce ne soit spécifiquement configuré sur false, ajoute une TOC à n’importe quelle page avec un .WordCount (voir Variables de page supérieur à 400. Cet exemple montre également comment utiliser les conditionnels dans votre modèle :

{{ if and (gt .WordCount 400 ) (ne .Params.toc "false") }}
<aside>
    <header>
    <h2>{{.Title}}</h2>
    </header>
    {{.TableOfContents}}
</aside>
{{ end }}