From 58a8677b8516ffafa8375406031a01e81483b90c Mon Sep 17 00:00:00 2001 From: southerntofu Date: Thu, 23 Apr 2020 00:10:49 +0200 Subject: [PATCH] Docs on taxonomies templates --- README.md | 15 ++++++++++----- 1 file changed, 10 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 951ea99..7908628 100644 --- a/README.md +++ b/README.md @@ -161,14 +161,22 @@ tags = [ "ssg", "tutorial" ] authors = [ "foobar" ] ``` -Then, you need to create templates for the taxonomies in your templates folder: +## Taxonomies templates + +Then, you need to create templates for the taxonomies in your site's templates folder: - tags/single.html <~~ about a specific tag - tags/list.html <~~ tags list - authors/single.html <~~ about a specific author - authors/list.html <~~ authors list -The variables you can use in those templates are described on [zola docs](https://www.getzola.org/documentation/templates/taxonomies/). +The variables you can use in those templates are described on [zola docs](https://www.getzola.org/documentation/templates/taxonomies/). Please be aware that taxonomy templates have no title/content or related section/page variables. + +**Note**: If your taxonomy template extends the theme's index.html, your site will crash if the template does not override the main block, as the one provided in index.html is intended for the homepage. This could be improved in the future, and patches are welcome! + +**WARNING**: Taxonomies templates don't have a lang in Zola <= 10.1. If you are running Zola 10.1, please be sure to override the header block as well, or your site will crash. + +**Note**: If you replace the theme's index.html entirely, please remember to include fallbacks for missing variables in taxonomies. These workarounds are marked "TAXONOMY" in the index.html so you can find them easily. # Translations for multilingual sites (i18n) @@ -184,9 +192,6 @@ This theme includes a few macros to help deal with with i18n concerns. They are {% import "widgets.html" as widgets %} ``` -In most templates, the `lang` variable is set. However that's not the case in all templates. -TODO: figure out where that was not the case - #### i18n_path Takes a `path` parameter to a content page/section, and a `lang` parameter. Returns the path to the page in the requested language.