hugo/docs/content/extras/toc.md

848 B

lastmod date menu next prev title
2015-01-27 2013-07-09
main
parent
extras
/extras/localfiles /extras/highlighting Table of Contents

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 .TableOfContents

Template Example

This is example code of a single.html template.

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