com.eden.orchid.posts.FeedsGenerator


Own Options

Type Default Value Description
feedTypes String[] [rss, atom] A list of different feed types to render. Each feed type is rendered as `/{feedType}.xml` from the `feeds/{feedType}.peb` resource.
includeFrom String[] [posts] A list of generator keys whose pages are included in this feed.
size int 25 The maximum number of entries to include in this feed.

Inherited Options

Type Default Value Description
allData Map {} 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.

com.eden.orchid.posts.FeedsGenerator$FeedPage


Own Options

Inherited Options

Type Default Value Description
allData Map {} 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.
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.
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.

com.eden.orchid.posts.PostsGenerator


Own Options

Type Default Value Description
authorsBaseDir String posts/authors The base directory in local resources to look for author configs/bios in.
baseDir String posts The base directory in local resources to look for blog post entries in.
categories JSONArray [] An array of Category configurations, which may be just the path of the category or a full configuration object. Categories are strictly hierarchical, which is denoted by the category path. If a category does not have an entry for its parent category, an error is thrown and Posts generation will not continue.
defaultConfig JSONObject {} The configuration for the default category, when no other categories are set up.
excerptSeparator String The shortcode used to manually set the breakpoint for a page summary, otherwise the summary is the first 240 characters of the post.

Inherited Options

Type Default Value Description
allData Map {} 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.

com.eden.orchid.posts.components.DisqusComponent


Own Options

Type Default Value Description
identifier String empty string A site-wide unique identifier for the comment section on this page. Defaults to the page's URL.
shortname String empty string Your disqus shortname.

Inherited Options

Type Default Value Description
allData Map {} 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.

com.eden.orchid.posts.components.RecentPostsComponent


Own Options

Type Default Value Description
category String empty string Only add latest posts from a specific category.
limit int 10 The maximum number of posts to include in this component.

Inherited Options

Type Default Value Description
allData Map {} 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.

com.eden.orchid.posts.functions.ExcerptFunction


Own Options

Inherited Options

com.eden.orchid.posts.menu.LatestPostsMenuType


Own Options

Type Default Value Description
category String empty string Only add latest posts from a specific category.
limit int 10 The maximum number of posts to include in this menu item.
title String empty string The title for the root menu item.

Inherited Options

Type Default Value Description
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.

com.eden.orchid.posts.model.Author


Own Options

Type Default Value Description
avatar String empty string A fully-specified URL to an avatar image, or a relative path to an Orchid image, used as a Gravatar default image.
email String empty string The author's email address, used to display a Gravatar.
gravatarDefault String empty string If no avatar is set, a specific Gravatar default, generated image may be used instead. One of [404, mm, identicon, monsterid, wavatar, retro, robohash, blank]
name String empty string The author's name. Authors are referenced by this name.

Inherited Options

com.eden.orchid.posts.model.CategoryModel


Own Options

Type Default Value Description
permalink String :category/:year/:month/:day/:slug The permalink structure to use for the blog posts in this category. Permalinks may be overridden on any individual post.
title String empty string The display title of the category. Defaults to the un-camelCased category key.

Inherited Options

com.eden.orchid.posts.pages.AuthorPage


Own Options

Type Default Value Description
permalink String authors/:authorName The permalink structure to use only for this author bio page.

Inherited Options

Type Default Value Description
allData Map {} 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.
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.
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.

com.eden.orchid.posts.pages.PostPage


Own Options

Type Default Value Description
author Author null The posts author. May be the `name` of a known author, or an anonymous Author config, only used for this post, which is considered as a guest author.
featuredImage AssetRelation https://orchid.netlify.com/ A fully-specified URL to a post's featured image, or a relative path to an Orchid image.
permalink String empty string The permalink structure to use only for this blog post. This overrides the permalink structure set in the category configuration.
postType String empty string A 'type' of post, such as 'gallery', 'video', or 'blog', which is used to determine the specificpost template to use for the Page Content.
tags String[] empty array A list of tags for this post, for basic taxonomic purposes. More complex taxonomic relationships may be managed by other plugins, which may take post tags into consideration.

Inherited Options

Type Default Value Description
allData Map {} 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.
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.
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.