aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/toc.txt
diff options
context:
space:
mode:
authorDmitry Shachnev <mitya57@gmail.com>2013-09-29 19:06:28 +0400
committerDmitry Shachnev <mitya57@gmail.com>2013-09-29 19:06:28 +0400
commit6efe75869ac7ab60ccadc0a9c4ac64f9a7722379 (patch)
treed727f9486de91449cbb10e513757ae04f38ac50d /docs/extensions/toc.txt
parent7d10f204203397c3ab34c20014fef55e3d8ba16d (diff)
downloadmarkdown-6efe75869ac7ab60ccadc0a9c4ac64f9a7722379.tar.gz
markdown-6efe75869ac7ab60ccadc0a9c4ac64f9a7722379.tar.bz2
markdown-6efe75869ac7ab60ccadc0a9c4ac64f9a7722379.zip
Mention new option in toc.txt
Diffstat (limited to 'docs/extensions/toc.txt')
-rw-r--r--docs/extensions/toc.txt2
1 files changed, 2 insertions, 0 deletions
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt
index 2a91bb6..260129c 100644
--- a/docs/extensions/toc.txt
+++ b/docs/extensions/toc.txt
@@ -58,6 +58,8 @@ The following options are provided to configure the output:
* **title**: Title to insert in TOC ``<div>``. Defaults to ``None``.
* **anchorlink**: Set to ``True`` to have the headers link to themselves.
Default is ``False``.
+* **permalink**: Set to ``True`` to have this extension generate Sphinx-style
+ permanent links near the headers (for use with Sphinx stylesheets).
If a 'marker' is not found in the document, then the toc is available as an
attribute of the Markdown class. This allows one to insert the toc elsewhere