diff options
Diffstat (limited to 'docs/extensions/toc.txt')
| -rw-r--r-- | docs/extensions/toc.txt | 12 |
1 files changed, 4 insertions, 8 deletions
diff --git a/docs/extensions/toc.txt b/docs/extensions/toc.txt index c6a99bf..0705564 100644 --- a/docs/extensions/toc.txt +++ b/docs/extensions/toc.txt @@ -90,13 +90,11 @@ The following options are provided to configure the output: Set to `True` or a string to generate permanent links at the end of each header. Useful with Sphinx stylesheets. - When set to `True` the paragraph symbol (¶ -- `¶`) is used as the link + 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. - - Default: `1` + 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 @@ -106,7 +104,7 @@ The following options are provided to configure the output: >>> text = ''' ... #Some Header ... ## Next Level''' - >>> from markdown.extensions.toc import TocExtension + >>> from markdown.extensions.toc import TocExtension >>> html = markdown.markdown(text, extensions=[TocExtension(baselevel=3)]) >>> print html <h3 id="some_header">Some Header</h3> @@ -126,6 +124,4 @@ The following options are provided to configure the output: The callable must return a string appropriate for use in HTML `id` attributes. * **`separator`**: - Word separator. Character which replaces whitespace in id. - - Default: `-`
\ No newline at end of file + Word separator. Character which replaces whitespace in id. Defaults to "`-`".
\ No newline at end of file |