From ec46692cf5c4d5e22950bc8e7d14cb0ec327fb87 Mon Sep 17 00:00:00 2001 From: Waylan Limberg Date: Wed, 7 Mar 2012 09:35:40 -0500 Subject: Rename docs/*.md => docs/*.txt The documentation uses features of Python-Markdown that are not supported on GitHub and it's better to get a source view of the docs anyway. For example, that way comments and bug reports can reference a specific line of a file. Of course, it makes sense for Github to render the README, so that is left with the `.md` file extension. --- docs/extensions/toc.md | 56 -------------------------------------------------- 1 file changed, 56 deletions(-) delete mode 100644 docs/extensions/toc.md (limited to 'docs/extensions/toc.md') diff --git a/docs/extensions/toc.md b/docs/extensions/toc.md deleted file mode 100644 index 632294b..0000000 --- a/docs/extensions/toc.md +++ /dev/null @@ -1,56 +0,0 @@ -title: Table of Contents Extension -prev_title: Sane Lists Extension -prev_url: sane_lists.html -next_title: Wikilinks Extension -next_url: wikilinks.html - -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: - -
- -
-

Header 1

-

Header 2

- -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 ``
``. Defaults to ``None``. -* **anchorlink**: Set to ``True`` to have the headers link to themselves. - Default is ``False``. -- cgit v1.2.3