aboutsummaryrefslogtreecommitdiffstats
path: root/docs/extensions/header_id.txt
diff options
context:
space:
mode:
authorJakub Klinkovský <j.l.k@gmx.com>2014-02-15 19:23:19 +0100
committerJakub Klinkovský <j.l.k@gmx.com>2014-02-15 19:23:19 +0100
commit731a73c7d57608d3294b3c90752a2ab0afa6e646 (patch)
tree7303c7cd13c598de6e98c5fa07fab3602880f5c4 /docs/extensions/header_id.txt
parent2eb6b2d233593ee04b16c8b5000925a5850d0257 (diff)
downloadmarkdown-731a73c7d57608d3294b3c90752a2ab0afa6e646.tar.gz
markdown-731a73c7d57608d3294b3c90752a2ab0afa6e646.tar.bz2
markdown-731a73c7d57608d3294b3c90752a2ab0afa6e646.zip
docs: update header_id documentation
Diffstat (limited to 'docs/extensions/header_id.txt')
-rw-r--r--docs/extensions/header_id.txt26
1 files changed, 16 insertions, 10 deletions
diff --git a/docs/extensions/header_id.txt b/docs/extensions/header_id.txt
index c1739a0..ce06f57 100644
--- a/docs/extensions/header_id.txt
+++ b/docs/extensions/header_id.txt
@@ -10,17 +10,17 @@ HeaderId
Summary
-------
-An extension to Python-Markdown that automatically generates 'id' attributes
-for HTML header elements (h1-h6) in markdown's output.
+The HeaderId extension automatically generates `id` attributes for the header
+elements (`h1`-`h6`) in the resulting HTML document.
This extension is included in the standard Markdown library.
Syntax
------
-By default, all headers will automatically have unique "id" attributes
-generated based upon the text of the header (See below to turn this off).
-Note this example in which all three headers would have the same "id":
+By default, all headers will automatically have unique `id` attributes
+generated based upon the text of the header (see below to turn this off).
+Note this example, in which all three headers would have the same `id`:
#Header
#Header
@@ -32,10 +32,16 @@ Results in:
<h1 id="header_1">Header</h1>
<h1 id="header_2">Header</h1>
-Configuring the Output
-----------------------
+Usage
+-----
-The HeaderId extension has four configuration settings:
+See [Extensions](./index.html) for general extension usage, specify `headerid`
+as the name of the extension.
+
+See the [Library Reference](../reference.html#extensions) for information about
+configuring extensions.
+
+The following options are provided to configure the output:
* **level**: Base level for headers.
@@ -59,8 +65,8 @@ The HeaderId extension has four configuration settings:
Default: `True`
The `forceid` setting turns on or off the automatically generated ids for
- headers that do not have one explicitly defined (using the attr_list
- extension).
+ headers that do not have one explicitly defined (using the
+ [Attribute List](attr_list.html) extension).
>>> text = '''
... # Some Header