Skip to content

Commit

Permalink
Document the render field on taxonomies (#2094)
Browse files Browse the repository at this point in the history
  • Loading branch information
davidmreed authored Feb 10, 2023
1 parent 9ea33f0 commit ae79a60
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/content/documentation/content/taxonomies.md
Original file line number Diff line number Diff line change
Expand Up @@ -62,14 +62,15 @@ 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.
- `paginate_path`: if set, this path will be used by the paginated page and the page number will be appended after it.
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):

Expand Down
2 changes: 2 additions & 0 deletions docs/content/documentation/templates/taxonomies.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit ae79a60

Please sign in to comment.