diff options
Diffstat (limited to 'plugins/headerid/README.rst')
| -rw-r--r-- | plugins/headerid/README.rst | 16 |
1 files changed, 16 insertions, 0 deletions
diff --git a/plugins/headerid/README.rst b/plugins/headerid/README.rst new file mode 100644 index 0000000..7bfa402 --- /dev/null +++ b/plugins/headerid/README.rst @@ -0,0 +1,16 @@ +Pelican ``headerid`` plugin +=========================== + +This plugin adds an anchor to each heading so you can deep-link to headers. +It is intended for formats such as reStructuredText that do not natively +generate these anchors. + +The ``HEADERID_LINK_CHAR`` config can be set to use a different char from ``*`` +for anchor text. + +For Markdown, this plugin is less relevant since the Python-Markdown library +includes a Table of Contents extension that will generate link anchors. +To enable the ``toc`` extension, add a line similar to the following example +to your Pelican settings file:: + + MD_EXTENSIONS = ["codehilite(css_class=highlight)", "extra", "toc"] |