title: Table of Contents Extension prev_title: SmartyPants Extension prev_url: smarty.html next_title: WikiLinks Extension next_url: wikilinks.html Table of Contents ================= Summary ------- The Table of Contents extension generates a Table of Contents from a Markdown document and adds it into the resulting HTML document. This extension is included in the standard Markdown library. Syntax ------ By default, all headers will automatically have unique `id` attributes generated based upon the text of the header. Note this example, in which all three headers would have the same `id`: #Header #Header #Header Results in:

Header

Header

Header

Place a marker in the document where you would like the Table of Contents to appear. Then, a nested list of all the headers in the document will replace the marker. The marker defaults to `[TOC]` so the following document: [TOC] # Header 1 ## Header 2 would generate the following output:

Header 1

Header 2

Regardless of whether a `marker` is found in the document (or disabled), the Table of Contents is available as an attribute (`toc`) on the Markdown class. This allows one to insert the Table of Contents elsewhere in their page template. For example: >>> md = markdown.Markdown(extensions=['markdown.extensions.toc']) >>> html = md.convert(text) >>> page = render_some_template(context={'body': html, 'toc': md.toc}) Usage ----- See [Extensions](index.html) for general extension usage, specify `markdown.extensions.toc` as the name of the extension. See the [Library Reference](../reference.html#extensions) for information about configuring extensions. The following options are provided to configure the output: * **`marker`**: Text to find and replace with the Table of Contents. Defaults to `[TOC]`. Set to an empty string to disable searching for a marker, which may save some time, especially on long documents. * **`title`**: Title to insert in the Table of Contents' `
`. Defaults to `None`. * **`anchorlink`**: Set to `True` to cause all headers to link to themselves. Default is `False`. * **`permalink`**: Set to `True` or a string to generate permanent links at the end of each header. Useful with Sphinx style sheets. When set to `True` the paragraph symbol (¶ or "`¶`") is used as the link text. When set to a string, the provided string is used as the link text. * **`baselevel`**: Base level for headers. Defaults to `1`. The `baselevel` setting allows the header levels to be automatically adjusted to fit within the hierarchy of your HTML templates. For example, suppose the Markdown text for a page should not contain any headers higher than level 3 (`

`). The following will accomplish that: >>> text = ''' ... #Some Header ... ## Next Level''' >>> from markdown.extensions.toc import TocExtension >>> html = markdown.markdown(text, extensions=[TocExtension(baselevel=3)]) >>> print html

Some Header

Next Level

' * **`slugify`**: Callable to generate anchors. Default: `markdown.extensions.headerid.slugify` In order to use a different algorithm to define the id attributes, define and pass in a callable which takes the following two arguments: * `value`: The string to slugify. * `separator`: The Word Separator. The callable must return a string appropriate for use in HTML `id` attributes. * **`separator`**: Word separator. Character which replaces white space in id. Defaults to "`-`".