Document the render field on taxonomies (#2094)

This commit is contained in:
David Reed 2023-02-10 01:31:49 -07:00 committed by GitHub
parent 9ea33f0dbd
commit ae79a605c6
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 4 additions and 1 deletions

View File

@ -62,7 +62,7 @@ In this example the page for `Release year` would include links to pages for bot
## Configuration
A taxonomy has five variables:
A taxonomy has six variables:
- `name`: a required string that will be used in the URLs, usually the plural version (i.e., tags, categories, etc.)
- `paginate_by`: if this is set to a number, each term page will be paginated by this much.
@ -70,6 +70,7 @@ A taxonomy has five variables:
For example the default would be page/1.
- `feed`: if set to `true`, a feed (atom by default) will be generated for each term.
- `lang`: only set this if you are making a multilingual site and want to indicate which language this taxonomy is for
- `render`: if set to `false`, pages will not be rendered for the taxonomy or for individual terms.
Insert into the configuration file (config.toml):

View File

@ -12,6 +12,8 @@ if they are not found, it will attempt to fall back on the following generic tem
- `taxonomy_single.html`
- `taxonomy_list.html`
The taxonomy templates are required only if at least one taxonomy exists with `render` set to `true`.
First, `TaxonomyTerm` has the following fields:
```ts