aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/Tables_of_Contents.txt
diff options
context:
space:
mode:
authorWaylan Limberg <waylan@gmail.com>2009-03-19 21:35:21 -0400
committerWaylan Limberg <waylan@gmail.com>2009-03-19 21:35:21 -0400
commitc1eb12e10480a60e2fc26a0091cafb779553a4fe (patch)
tree98b0a5cdceb23430c84433f25516796ec3e7ed06 /docs/extensions/Tables_of_Contents.txt
parent70c81659eca814bb037b93c95996210d192e5ca5 (diff)
downloadmarkdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.tar.gz
markdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.tar.bz2
markdown-c1eb12e10480a60e2fc26a0091cafb779553a4fe.zip
Added documentation for the rest of the extensions included with the distribution.
Diffstat (limited to 'docs/extensions/Tables_of_Contents.txt')
-rw-r--r--docs/extensions/Tables_of_Contents.txt50
1 files changed, 50 insertions, 0 deletions
diff --git a/docs/extensions/Tables_of_Contents.txt b/docs/extensions/Tables_of_Contents.txt
new file mode 100644
index 0000000..032c25c
--- /dev/null
+++ b/docs/extensions/Tables_of_Contents.txt
@@ -0,0 +1,50 @@
+Table of Contents
+=================
+
+Summary
+-------
+
+Adds a Table of Contents to a Markdown document.
+
+This extension is included with the Markdown library since version 2.0.
+
+Syntax
+------
+
+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:
+
+ <div class="toc">
+ <ul>
+ <li><a href="#header-1">Header 1</a></li>
+ <ul>
+ <li><a href="#header-2">Header 2</a></li>
+ </ul>
+ </ul>
+ </div>
+ <h1 id="header-1">Header 1</h1>
+ <h1 id="header-2">Header 2</h1>
+
+Configuration Options
+---------------------
+
+The following options are provided to configure the output:
+
+* **marker**: Text to find and replace with the Table of Contents. Defaults
+ to ``[TOC]``.
+* **slugify**: Callable to generate anchors based on header text. Defaults to a
+ built in ``slugify`` method. The callable must accept one argument which
+ contains the text content of the header and return a string which will be
+ used as the anchor text.
+* **title**: Title to insert in TOC ``<div>``. Defaults to ``None``.
+* **anchorlink**: Set to ``True`` to have the headers link to themselves.
+ Default is ``False``.