feat(table of contents): Add table of contents This feature is disabled by default, but can be enabled/disabled globally or per-page. Zola already provides `page.toc`, this PR simply adds a macro to recursively render that data in nested `ul`s. It also establishes some configuration options to display it and set a maximum headers level.
6 files changed, 53 insertions(+), 1 deletion(-)
M README.md → README.md
@@ -73,6 +73,29 @@ ### Adding your branding / colors / css Add a `custom_head.html`-file to your `templates/`-directory. In there you may add a `<style>`-tag, *or* you may add a `<link>`-tag referencing your own `custom.css` (in case you prefer to have a separate `.css`-file). Check out the [`style.html`](https://codeberg.org/alanpearce/zola-bearblog/src/branch/main/templates/style.html)-file to find out which CSS-styles are applied by default. +### Table of contents + +Table of contents are not rendered by default. To render them, set `extra.table_of_contents.show = true` in `config.toml`. + +The table of contents is rendered inside a `details` element. +If you want the section to be collapsed on page load, set `extra.table_of_contents.visible_on_load = false`. +This defaults to `true`. + +In addition, `extra.table_of_contents.max_level` can limit the maximum level of headers to show. +To show only `h1`s, set `max_level = 1`, to show `h1`s and `h2`s, set `max_level = 2`, and so on. +By default, `max_level` is set to 6, so all headers on the page are shown. + +Below is an example of how to configure the table of contents in `config.toml`. + +```toml +[extra.table_of_contents] +show = true +max_level = 2 +visible_on_load = false +``` + +It can also be toggled on page-by-page basis. Add `extra.hide_table_of_contents = true` to the page's frontmatter to hide the table of contents for that specific page. + ## Issues / Feedback / Contributing Please use [Codeberg issues](https://codeberg.org/alanpearce/zola-bearblog/issues) and [Pull Requests](https://codeberg.org/alanpearce/zola-bearblog/pulls).
M config.toml → config.toml
@@ -45,11 +45,15 @@ [extra] date_format="%Y-%m-%d" webserver_sends_csp_headers=true language_switcher=true - translations = [ { code="en", name="English" }, { code="de", name="Deutsch" }, ] + +[extra.table_of_contents] +show=true +max_level=2 +visible_on_load=true [[extra.main_menu]] name = "Home"
M content/zola.md → content/zola.md
@@ -1,5 +1,6 @@ +++ title = "Zola" +extra.hide_table_of_contents = true +++ ## No dependencies
A templates/macros.html
@@ -0,0 +1,12 @@ +{% macro table_of_contents(toc, max_level) %} +<ul> + {% for header in toc %} + <li> + <a href="{{ header.permalink | safe }}">{{ header.title }}</a> + {% if header.children and header.level < max_level %} + {{ self::table_of_contents(toc=header.children, max_level=max_level) }} + {% endif %} + </li> + {% endfor %} +</ul> +{% endmacro %}
M templates/page.html → templates/page.html
@@ -1,3 +1,4 @@ +{% import "macros.html" as macros %} {% extends "base.html" %} {% block title %}{{ page.title }} | {{ super() }}{% endblock %}@@ -14,6 +15,12 @@ </time> </i> </p> {%- endif %} + {%- endif %} + {%- if config.extra.table_of_contents.show and not page.extra.hide_table_of_contents and page.toc %} + <details {%if config.extra.table_of_contents.visible_on_load %}open{% endif %}> + <summary>Table of Contents</summary> + {{ macros::table_of_contents(toc=page.toc, max_level=config.extra.table_of_contents.max_level) }} + </details> {%- endif %} <main> {{ page.content | safe }}
M theme.toml → theme.toml
@@ -15,6 +15,11 @@ [extra] date_format="%d %b, %Y" webserver_sends_csp_headers=false +[extra.table_of_contents] +show=false +max_level=6 +visible_on_load=true + [author] name = "Alan Pearce" homepage = "https://alanpearce.eu"