hugo/docs/content/extras/toc.md

---
date: 2013-07-09
menu:
  main:
    parent: extras
next: /extras/urls
prev: /extras/highlighting
title: Table of Contents
weight: 100
---

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" . }}
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00			`---`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`date: 2013-07-09`
Implementing new menu system in the docs site 2014-04-23 07:00:11 +00:00			`menu:`
			`main:`
Converting front matter to YAML 2014-05-29 22:42:05 +00:00			`parent: extras`
			`next: /extras/urls`
			`prev: /extras/highlighting`
			`title: Table of Contents`
Documentation for `ref` and `relref`. - Rejigged the weight of the extras/ content for the new crossreferences page. - Used the new {{</…/>}} format for documenting highlighting and to prevent a warning about the missing `fig` shortcode. 2014-11-25 08:07:18 +00:00			`weight: 100`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00			`---`

Minor proofreading corrections to Hugo docs 2014-08-31 11:08:36 +00:00			`Hugo will automatically parse the Markdown for your content and create`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00			`a Table of Contents you can use to guide readers to the sections within`
Switching docs highlighting to highlight.js .. Docs build super fast again! 2014-05-15 13:58:55 +00:00			`your content.`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00
			`## Usage`

			`Simply create content like you normally would with the appropriate`
Switching docs highlighting to highlight.js .. Docs build super fast again! 2014-05-15 13:58:55 +00:00			`headers.`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00
Minor proofreading corrections to Hugo docs 2014-08-31 11:08:36 +00:00			`Hugo will take this Markdown and create a table of contents stored in the`
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-28 02:17:09 +00:00			[content variable](/layout/variables/) `.TableOfContents`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00

			`## Template Example`

[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly 2015-01-28 02:17:09 +00:00			`This is example code of a [single.html template](/layout/content/).`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00
More proofreading and minor revisions to Hugo docs Among the various changes, most instances of {{ template "partials/FILE.html" . }} were changed to {{ partial "FILE.html" . }} Also, in main.go, change "2013" to "2013-14". 2014-09-03 04:12:26 +00:00			`{{ partial "header.html" . }}`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00			`<div id="toc" class="well col-md-4 col-sm-6">`
			`{{ .TableOfContents }}`
			`</div>`
			`<h1>{{ .Title }}</h1>`
			`{{ .Content }}`
More proofreading and minor revisions to Hugo docs Among the various changes, most instances of {{ template "partials/FILE.html" . }} were changed to {{ partial "FILE.html" . }} Also, in main.go, change "2013" to "2013-14". 2014-09-03 04:12:26 +00:00			`{{ partial "footer.html" . }}`
Adding documentation on Table of Contents functionality 2014-02-21 00:04:08 +00:00