summaryrefslogtreecommitdiffstats
path: root/content/templates/taxonomies.md
diff options
context:
space:
mode:
Diffstat (limited to 'content/templates/taxonomies.md')
-rw-r--r--content/templates/taxonomies.md68
1 files changed, 68 insertions, 0 deletions
diff --git a/content/templates/taxonomies.md b/content/templates/taxonomies.md
new file mode 100644
index 0000000..1ca3286
--- /dev/null
+++ b/content/templates/taxonomies.md
@@ -0,0 +1,68 @@
++++
+title = "Taxonomies"
+weight = 40
++++
+
+Zola will look up the following files in the `templates` directory:
+
+- `$TAXONOMY_NAME/single.html`
+- `$TAXONOMY_NAME/list.html`
+
+First, `TaxonomyTerm` has the following fields:
+
+```ts
+name: String;
+slug: String;
+permalink: String;
+pages: Array<Page>;
+```
+
+and `TaxonomyConfig` has the following fields:
+
+```ts
+name: String,
+paginate_by: Number?;
+paginate_path: String?;
+feed: Bool;
+lang: String;
+```
+
+
+### Taxonomy list (`list.html`)
+
+This template is never paginated and therefore gets the following variables in all cases.
+
+```ts
+// The site config
+config: Config;
+// The data of the taxonomy, from the config
+taxonomy: TaxonomyConfig;
+// The current full permalink for that page
+current_url: String;
+// The current path for that page
+current_path: String;
+// All terms for that taxonomy
+terms: Array<TaxonomyTerm>;
+// The lang of the current page
+lang: String;
+```
+
+
+### Single term (`single.html`)
+```ts
+// The site config
+config: Config;
+// The data of the taxonomy, from the config
+taxonomy: TaxonomyConfig;
+// The current full permalink for that page
+current_url: String;
+// The current path for that page
+current_path: String;
+// The current term being rendered
+term: TaxonomyTerm;
+// The lang of the current page
+lang: String;
+```
+
+A paginated taxonomy term will also get a `paginator` variable; see the
+[pagination page](@/templates/pagination.md) for more details.