Skip to content

Commit ef0d801

Browse files
davidmreedNewbytee
authored andcommitted
Document the render field on taxonomies (getzola#2094)
1 parent 9d71a0d commit ef0d801

File tree

2 files changed

+4
-1
lines changed

2 files changed

+4
-1
lines changed

docs/content/documentation/content/taxonomies.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -62,14 +62,15 @@ In this example the page for `Release year` would include links to pages for bot
6262

6363
## Configuration
6464

65-
A taxonomy has five variables:
65+
A taxonomy has six variables:
6666

6767
- `name`: a required string that will be used in the URLs, usually the plural version (i.e., tags, categories, etc.)
6868
- `paginate_by`: if this is set to a number, each term page will be paginated by this much.
6969
- `paginate_path`: if set, this path will be used by the paginated page and the page number will be appended after it.
7070
For example the default would be page/1.
7171
- `feed`: if set to `true`, a feed (atom by default) will be generated for each term.
7272
- `lang`: only set this if you are making a multilingual site and want to indicate which language this taxonomy is for
73+
- `render`: if set to `false`, pages will not be rendered for the taxonomy or for individual terms.
7374

7475
Insert into the configuration file (config.toml):
7576

docs/content/documentation/templates/taxonomies.md

+2
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,8 @@ if they are not found, it will attempt to fall back on the following generic tem
1212
- `taxonomy_single.html`
1313
- `taxonomy_list.html`
1414

15+
The taxonomy templates are required only if at least one taxonomy exists with `render` set to `true`.
16+
1517
First, `TaxonomyTerm` has the following fields:
1618

1719
```ts

0 commit comments

Comments
 (0)