summaryrefslogtreecommitdiffstats
path: root/plugins/headerid/README.rst
blob: 7bfa4029af483959d5ca3649cd9f83033e98650c (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
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"]