Taxonomies

Create custom archives from any logically-related content.

Default Config
# config.yml
...
taxonomies:
  taxonomies: empty list
or
# config/taxonomies.yml
taxonomies: empty list
Key Type Default Value Description
taxonomies List<Taxonomy> empty list

An array of Taxonomy configurations.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

layout String empty string

Set the default layout to be used for all Pages from this Generator. Pages can specify their own layouts, which take precedence over the Generator layout.

parallel boolean false

Improve site generation performance dramatically by rendering the pages from this Generator in parallel. There are currently thread-safety issues that may cause deadlocks, especially when in serve mode when build cycles may be executed multiple times. As such this feature should be considered highly experimental and used with caution.

theme Object null

Set a theme to be used only when rendering pages from this Generator. This can be a String to use that theme's default options set in config.yml, or an object with a key property to use those specific options for the theme.

Taxonomy

Show a list of all Taxonomies.

100: [taxonomy]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "taxonomy"
    taxonomyType: empty string

Key Type Default Value Description
taxonomyType String empty string

The Taxonomy to include terms from.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

extraCss String[] empty array

Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site's assets.

hidden boolean false

When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.

noWrapper boolean false

When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.

order int 0

By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.

template String[] empty array

Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.

Taxonomy Terms

Show a list of all terms in a Taxonomy.

100: [taxonomyTerm]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "taxonomyTerm"
    taxonomyType: empty string
    termType: empty string

Key Type Default Value Description
taxonomyType String empty string

The Taxonomy to include terms from.

termType String empty string

The Term within the Taxonomy to include pages from.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

extraCss String[] empty array

Add extra CSS files to the page containing this Component, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to the page containing this Component, which will be compiled just like the rest of the site's assets.

hidden boolean false

When true, this component will not have a template rendered on the page. Useful for Components that only add extra CSS or JS, or for temporarily removing a component from the page.

noWrapper boolean false

When true, this component will not be wrapped in a wrapper element. The wrapper element is determinedby the theme, and it is up to the theme to ensure this is implemented properly.

order int 0

By default, components are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual component. A higher value for order will render that component earlier in the list.

template String[] empty array

Specify a template or a list of templates to use when rendering this component. The first template that exists will be chosen for this component.

All Taxonomies

Links to all the Taxonomy landing pages.

Key Type Default Value Description
title String Taxonomies

The menu item title.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

asSubmenu boolean false

Set all the menu items from this as a dropdown, instead of including them directly at the root.

order int 0

By default, menu items are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual menu item. A higher value for order will render that menu item earlier in the list.

submenuTitle String empty string

The title the menu

Taxonomy

Link to a specific Taxonomy landing page, optionally with links to its Term landing pages underneath it.

Key Type Default Value Description
includeTerms boolean false

Whether to have the menu link out to the Taxonomy landing page, or include child menu items with links out to the Term landing pages.

taxonomyType String empty string

The Taxonomy to include terms from.

termsAtRoot boolean false

If includeTerms is true, whether to keep the terms as children of a single menu item, or expand them all to the root.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

asSubmenu boolean false

Set all the menu items from this as a dropdown, instead of including them directly at the root.

order int 0

By default, menu items are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual menu item. A higher value for order will render that menu item earlier in the list.

submenuTitle String empty string

The title the menu

Taxonomy Term

Link to a specific Taxonomy Term landing page, optionally with links to its associated pages.

Key Type Default Value Description
includePages boolean false

Whether to have the menu link out to the Term landing page, or include child menu items with links out to the Term's associated pages.

limit int 4

The maximum number of associated pages to include in this menu item.

pagesAtRoot boolean false

If includePages is true, whether to keep the associated pages as children of a single menu item, or expand them all to the root.

taxonomyType String empty string

The Taxonomy to include terms from.

termType String empty string

The Term within the Taxonomy to include pages from.

Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

asSubmenu boolean false

Set all the menu items from this as a dropdown, instead of including them directly at the root.

order int 0

By default, menu items are rendered in the order in which they are declared, but the ordering can be changed by setting the order on any individual menu item. A higher value for order will render that menu item earlier in the list.

submenuTitle String empty string

The title the menu

Taxonomy

Key Type Default Value Description
allData Map<String> {}

All options passed to this object.

excludeFrom String[] empty array

A list of generator keys whose pages are ignored by this taxonomy.

includeFrom String[] empty array

A list of generator keys whose pages are considered in this taxonomy.

key String empty string
orderBy String[] empty array

A list of properties to order the Terms by.

orderByDirection String desc

Whether to sort in ascending or descending order. One of [asc, desc].

pageSize int 100

The maximum number of term pages to include in a single page in the Taxonomy archive.

permalink String :taxonomy/:archiveIndex

The permalink structure to use for this taxonomy's archive pages.

setAsPageParent boolean false

If true, pages selected by this taxonomy will have their parent page be set as the term archive, creating a complete breadcrumb hierarchy.

WARNING: This will override the parent page set by the plugin that originally produced the page, effectively replacing its normal hierarchy with this taxonomy's hierarchy.

single boolean false

Whether a single page may be associated to multiple Terms in this Taxonomy, or just a single one.

singleKey String empty string

If single is false, you may still use singular properties of a page to be included as that page's only Term, by setting it as the singleKey. For example, 'categories' may not be a singular Taxonomy, but a page may have a singular property of 'category' that should still be captured.

title String empty string

The displayed title of the Taxonomy. Defaults to the un-camelCased Taxonomy key.

No options

Term

Key Type Default Value Description
allData Map<String> {}

All options passed to this object.

orderBy String[] empty array

A list of properties to order the associated pages by.

orderByDirection String desc

Whether to sort in ascending or descending order. One of [asc, desc].

pageSize int 100

The maximum number of associated pages to include in a single page in the Term archive.

permalink String :taxonomy/:term/:archiveIndex

The permalink structure to use for this term's archive pages.

title String empty string

The displayed title of the Term. Defaults to the un-camelCased Term key.

No options

Taxonomy

A paginated page for all the Terms in a Taxonomy.

No options
Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

changeFrequency String empty string

A rough estimate of how frequently the content of this page changes, primarily to include in the generated sitemap.xml. One of [always, hourly, daily, weekly, monthly, yearly, never].

components ComponentHolder Empty ComponentHolder

The components that comprise the main content body for this page. The 'intrinsic content' of the page, which is typically the rendered markup of the containing file, is added by default as a component of type pageContent if none are specified. The full pageContent component is rendered within the chosen page template. If a custom list of components is given, you will need to add the pageContent component yourself.

defaultBreadcrumbs String empty string

The default breadcrumbs to display for this page.

description String empty string

Specify a custom description for this page, to include in the meta description tag.

draft boolean false

Set this page as currently being a draft. Drafts will not be included in the rendered site.

expiryDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page expires. Pages with an expiry date in the past are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30.

extraCss String[] empty array

Add extra CSS files to this page only, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to every this page only, which will be compiled just like the rest of the site's assets.

lastModifiedDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page was last modified. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30.

layout String empty string

The layout to embed this page in, or 'none' to render the page content without a layout. A page's default layout, if none is specified, is index

menu OrchidMenu Empty OrchidMenu

The secondary only added to this page. It is common for generators to add menu items to their pagesautomcatically, but the menu specified on the page will take precedence over the generator's page.

next PageRelation com.eden.orchid.impl.relations.PageRelation@79a1548b
noFollow boolean false

Request that search engines do not follow links from this page by adding a meta tag on in the page's head.

noIndex boolean false

Request that search engines do not index this page by adding a meta tag on in the page's head.

parent PageRelation com.eden.orchid.impl.relations.PageRelation@b3cc4a8
previous PageRelation com.eden.orchid.impl.relations.PageRelation@d6f69f6
publishDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page was published. Pages with a publish date in the future are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30. Note that some generators may choose to set this value based on some external criteria, but the value in front matter should take precedence over the generator's determined publish date.

relativePriority float 0.0

The importance of this page relative to the rest of the pages on your site. Should be a value between 0 and 1.

template String[] empty array

Specify a template or a list of templates to use when rendering this page. The first template that exists will be chosen for this page, otherwise the page's default set of templates will be searched for (which typically is customized by the generator that produces this page).

title String empty string

Specify a custom title for this Page, which takes precedence over the title given by its generator.

Taxonomy Term

A paginated page for all the Pages in a Taxonomy Term.

No options
Key Type Default Value Description
allData Map<String, Object> {}

All options passed to this object.

changeFrequency String empty string

A rough estimate of how frequently the content of this page changes, primarily to include in the generated sitemap.xml. One of [always, hourly, daily, weekly, monthly, yearly, never].

components ComponentHolder Empty ComponentHolder

The components that comprise the main content body for this page. The 'intrinsic content' of the page, which is typically the rendered markup of the containing file, is added by default as a component of type pageContent if none are specified. The full pageContent component is rendered within the chosen page template. If a custom list of components is given, you will need to add the pageContent component yourself.

defaultBreadcrumbs String empty string

The default breadcrumbs to display for this page.

description String empty string

Specify a custom description for this page, to include in the meta description tag.

draft boolean false

Set this page as currently being a draft. Drafts will not be included in the rendered site.

expiryDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page expires. Pages with an expiry date in the past are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30.

extraCss String[] empty array

Add extra CSS files to this page only, which will be compiled just like the rest of the site's assets.

extraJs String[] empty array

Add extra Javascript files to every this page only, which will be compiled just like the rest of the site's assets.

lastModifiedDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page was last modified. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30.

layout String empty string

The layout to embed this page in, or 'none' to render the page content without a layout. A page's default layout, if none is specified, is index

menu OrchidMenu Empty OrchidMenu

The secondary only added to this page. It is common for generators to add menu items to their pagesautomcatically, but the menu specified on the page will take precedence over the generator's page.

next PageRelation com.eden.orchid.impl.relations.PageRelation@3de53faa
noFollow boolean false

Request that search engines do not follow links from this page by adding a meta tag on in the page's head.

noIndex boolean false

Request that search engines do not index this page by adding a meta tag on in the page's head.

parent PageRelation com.eden.orchid.impl.relations.PageRelation@57b4c351
previous PageRelation com.eden.orchid.impl.relations.PageRelation@46d4842d
publishDate LocalDateTime now (yyyy-mm-dd HH:MM:SS)

Set when this page was published. Pages with a publish date in the future are considered a draft. Should be a valid ISO-8601 date or datetime without timezone, such as 2018-01-01 or 2018-01-01T08:15:30. Note that some generators may choose to set this value based on some external criteria, but the value in front matter should take precedence over the generator's determined publish date.

relativePriority float 0.0

The importance of this page relative to the rest of the pages on your site. Should be a value between 0 and 1.

template String[] empty array

Specify a template or a list of templates to use when rendering this page. The first template that exists will be chosen for this page, otherwise the page's default set of templates will be searched for (which typically is customized by the generator that produces this page).

title String empty string

Specify a custom title for this Page, which takes precedence over the title given by its generator.