aboutsummaryrefslogtreecommitdiffstats
path: root/content/extras/toc.md
blob: 68376e1175da169c25962b5dcc6be459d7d2c44a (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
---
date: 2013-07-09
menu:
  main:
    parent: extras
next: /extras/urls
prev: /extras/highlighting
title: Table of Contents
weight: 60
---

Hugo will automatically parse the Markdown for your content and create
a Table of Contents you can use to guide readers to the sections within
your content.

## Usage

Simply create content like you normally would with the appropriate
headers.

Hugo will take this Markdown and create a table of contents stored in the
[content variable](/layout/variables) `.TableOfContents`


## Template Example

This is example code of a [single.html template](/layout/content).

    {{ partial "header.html" . }}
        <div id="toc" class="well col-md-4 col-sm-6">
        {{ .TableOfContents }}
        </div>
        <h1>{{ .Title }}</h1>
        {{ .Content }}
    {{ partial "footer.html" . }}