Adds support for anchors and table of contents to Markdown.
Project description
# lektor-markdown-header-anchors
This plugin extends the markdown support in Lektor in a way that headlines
are given anchors and a table of contents is collected.
## Enabling the Plugin
To enable the plugin run this command:
```
$ lektor plugins add markdown-header-anchors
```
## In Templates
Within templates it becomes possible to access the `.toc` property of
markdown data. It's a list where each item has the following attributes:
* `anchor`: the name of the anchor
* `title`: the title of the headline as HTML
* `children`: a list of headers below that header
Example rendering:
```jinja
<h4>Table Of Contents</h4>
<ul class="toc">
{% for item in this.body.toc recursive %}
<li><a href="#{{ item.anchor }}">{{ item.title }}</a>{%
if item.children %}<ul>{{ loop(item.children) }}</ul>{% endif %}
{% endfor %}
</ul>
```
This plugin extends the markdown support in Lektor in a way that headlines
are given anchors and a table of contents is collected.
## Enabling the Plugin
To enable the plugin run this command:
```
$ lektor plugins add markdown-header-anchors
```
## In Templates
Within templates it becomes possible to access the `.toc` property of
markdown data. It's a list where each item has the following attributes:
* `anchor`: the name of the anchor
* `title`: the title of the headline as HTML
* `children`: a list of headers below that header
Example rendering:
```jinja
<h4>Table Of Contents</h4>
<ul class="toc">
{% for item in this.body.toc recursive %}
<li><a href="#{{ item.anchor }}">{{ item.title }}</a>{%
if item.children %}<ul>{{ loop(item.children) }}</ul>{% endif %}
{% endfor %}
</ul>
```
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for lektor-markdown-header-anchors-0.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 19b2110092c8c783bc942576f7bc11465464a43dfece2498b4e46fb895833a99 |
|
MD5 | 7cc738cace74182b1ae9a6cba3629796 |
|
BLAKE2b-256 | 80afcf821c17f35e0d4e21ae4beed647284fd149a53dd2d7798f5f3d1c96ec1c |
Close
Hashes for lektor_markdown_header_anchors-0.2-py2-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cae9262c872d91684d0ee736f6771f71745c034c64ed600111119bd1df95e70c |
|
MD5 | 05da43189eeb25daf1b974244a0efdc7 |
|
BLAKE2b-256 | 99595563363ec247dbe8bad0ac6dd3785ee2d0f31d27a8e3dea80dfba1ed84c0 |