This plugin generates a table of contents for pelican articles and pages, available for themes via article.toc
.
Beautifulsoup4 - install via pip install beautifulsoup4
{% if article.toc %}
<div class="col-lg-3 hidden-xs hidden-sm">
{{article.toc}}
</div>
{% endif %}
Title: Peeking at erlang/chicagoboss
###Intro
###Chicagoboss Magic
###Result
<div class="col-lg-3 hidden-xs hidden-sm">
<div id="toc">
<ul>
<li>
<a href="#" title="Peeking at erlang/chicagoboss">Peeking at erlang/chicagoboss</a>
<ul>
<li>
<a href="#intro" title="Intro">Intro</a>
</li>
<li>
<a href="#chicagoboss-magic" title="Chicagoboss Magic">Chicagoboss Magic</a>
</li>
<li>
<a href="#result" title="Result">Result</a>
</li>
</ul>
</li>
</ul>
</div>
</div>
TOC = {
'TOC_HEADERS' : '^h[1-6]', # What headers should be included in
# the generated toc
# Expected format is a regular expression
'TOC_RUN' : 'true', # Default value for toc generation,
# if it does not evaluate
# to 'true' no toc will be generated
'TOC_INCLUDE_TITLE': 'true', # If 'true' include title in toc
}
All those settings can be overwritten on a per page/article basis via metadata.
Just use the respective keyword as metadata (example: toc_headers: ^h[1-4]
)
extract-toc
uses a markdown extension to generate a toc and then extract it via beautifulsoup.
This extension generates the toc itself, removing the need to write [ToC]
in your articles.
There also is a 'health' check on id's which should be generated via markdown.extensions.headerid per default, but somehow don't always end up in the output.