A Python-Markdown extension to downgrade headings
Project description
Headdown: Downgrade Headings
Automatically demote those pesky headings!
What?
This is a plugin for Python-Markdown to automatically downgrade headings by a given number of levels. This is useful when, for example, using a static site generator, such as Pelican.
Why?
I didn't want to have to write standalone markdown files whose structure was dictated by the constraints of my website; nor did I want to sacrifice the structure of my website because of my markdown files. A number of 3rd party Python-Markdown extensions already exist to do this (here and here), but I was unable to get them to work with Python-Markdown 3.
How?
Just add mdx_headdown
to your markdown
extensions
and feel the magic.
You can optionally provide an offset
parameter, which tells headdown
by how many levels to downgrade all headings. The default is 1
.
Note : This value will be converted to an integer and absolutised. Failure to provide a numeric option may lead to unexpected results.
For example, if using with Pelican, your configuration might look something like this:
...
MARKDOWN = {
'extensions': ['mdx_headdown',],
'extension_configs': {
'mdx_headdown': {
'offset': 2,
},
},
}
...
Credit
Thanks are owed to the author of mdx_downheader, whose code I examined for inspiration; and the contributers to the default python-markdown extensions, whose code I examined to get a better idea of what the manual was talking about.
This project is copyright 2018 by Sascha Cowley under the MIT License.
Project details
Release history Release notifications | RSS feed
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
Hashes for markdown_headdown-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 30d819d719e53e9b06d060b30fda2cb5753a76a762de279eedbd638840733c82 |
|
MD5 | d24ef83f314f644d522c9d1f767cd5b9 |
|
BLAKE2b-256 | 61f42766f7219c96f124b7ea53e6cae8090f325a7525212b51b5d9aa4b9b7caa |