diff options
author | Waylan Limberg <waylan.limberg@icloud.com> | 2015-02-07 14:22:47 -0500 |
---|---|---|
committer | Waylan Limberg <waylan.limberg@icloud.com> | 2015-02-07 14:22:47 -0500 |
commit | 93dad08ca9967d75e5bb2b2e6e6301a98b900bfd (patch) | |
tree | 253586450b9bdaa9b04d853f23b6b590e0eb58ea /docs/extensions/header_id.txt | |
parent | 9f6b45f8944a2d91041e941da609e5ac09373e22 (diff) | |
download | markdown-93dad08ca9967d75e5bb2b2e6e6301a98b900bfd.tar.gz markdown-93dad08ca9967d75e5bb2b2e6e6301a98b900bfd.tar.bz2 markdown-93dad08ca9967d75e5bb2b2e6e6301a98b900bfd.zip |
Thorough spell check of the docs.
Diffstat (limited to 'docs/extensions/header_id.txt')
-rw-r--r-- | docs/extensions/header_id.txt | 11 |
1 files changed, 6 insertions, 5 deletions
diff --git a/docs/extensions/header_id.txt b/docs/extensions/header_id.txt index 42e640e..5557b1b 100644 --- a/docs/extensions/header_id.txt +++ b/docs/extensions/header_id.txt @@ -55,14 +55,14 @@ The following options are provided to configure the output: Default: `1` The `level` setting allows you to automatically adjust the header levels to - fit within the hierarchy of your html templates. For example, suppose the + 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 (`<h3>`). The following will accomplish that: >>> text = ''' ... #Some Header ... ## Next Level''' - >>> from markdown.extensions.headerid import HeaderIdExtension + >>> from markdown.extensions.headerid import HeaderIdExtension >>> html = markdown.markdown(text, extensions=[HeaderIdExtension(level=3)]) >>> print html <h3 id="some_header">Some Header</h3> @@ -79,13 +79,14 @@ The following options are provided to configure the output: >>> text = ''' ... # Some Header ... # Header with ID # { #foo }''' - >>> html = markdown.markdown(text, - extensions=['attr_list', HeaderIdExtension(forceid=False)]) + >>> html = markdown.markdown(text, + extensions=['markdown.extensions.attr_list', + HeaderIdExtension(forceid=False)]) >>> print html <h1>Some Header</h1> <h1 id="foo">Header with ID</h1> -* **`separator`**: Word separator. Character which replaces whitespace in id. +* **`separator`**: Word separator. Character which replaces white space in id. Default: `-` |