RSS Feeds

Generate feeds for you blog in RSS and Atom formats.

Default Config
# config.yml
...
feeds:
  feedTypes: [rss, atom]
  includeFrom: [posts]
  size: 25
or
# config/feeds.yml
feedTypes: [rss, atom]
includeFrom: [posts]
size: 25
Key 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.

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.

Key Type Description
allGenerators Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

RSS Feed

A page with an RSS-like feed.

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@7f2f9122
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@12306cc
previous PageRelation com.eden.orchid.impl.relations.PageRelation@6efb7aca
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.

Key Type Description
allPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

Blog Posts

Share your thoughts and interests with blog posts.

Default Config
# config.yml
...
posts:
  authors: empty list
  authorsBaseDir: posts/authors
  baseDir: posts
  categories: empty list
  defaultConfig: a new instance of CategoryModel
  excerptSeparator: <!--more-->
or
# config/posts.yml
authors: empty list
authorsBaseDir: posts/authors
baseDir: posts
categories: empty list
defaultConfig: a new instance of CategoryModel
excerptSeparator: <!--more-->
Key Type Default Value Description
authors List<Author> empty list

A list of Author objects denoting the 'regular' or known authors of the blog. Authors can also be set up from a resource in the authorsBaseDir. All known authors will have a page generated for them and will be linked to the pages they author. Guest authors may be set up directly in the post configuration, but they will not have their own pages.

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 List<CategoryModel> empty list

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 CategoryModel a new instance of CategoryModel

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.

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.

Key Type Description
allGenerators Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

Disqus

Easily add comments to any page with Disqus.

100: [disqus]

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

Key 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.

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.

No archetypes

Recent Posts

Render a list of the most recent blog posts.

25: [recentPosts]

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

Key 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.

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.

No archetypes

Excerpt

Show a snippet of a page's content.

Key Type Default Value Description
input Object null
No options
No archetypes

Recent Posts

Render a list of the most recent blog posts.

Key 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.

No options
No archetypes

Latest Posts

Latest posts, optionally by category.

Key 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.

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

No archetypes

Author

Key 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.

social Social a new instance of Social

The author's social media links.

No options
No archetypes

Category Model

Key Type Default Value Description
key String empty string
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.

No options
Key Type Description
posts.defaultConfig Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

Author

An 'about' page for an author in your blog.

Key Type Default Value Description
permalink String authors/:authorName

The permalink structure to use only for this author bio page.

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@7656726c
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@2b73e956
previous PageRelation com.eden.orchid.impl.relations.PageRelation@5e31df0a
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.

Key Type Description
allPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

posts.authorPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

posts.allPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

Blog Post

A blog post.

Key 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 null

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.

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@18722983
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@7a48b916
previous PageRelation com.eden.orchid.impl.relations.PageRelation@422ea9f7
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.

Key Type Description
allPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

posts.postPages Post Category

Configure all posts in the same category. Additional configuration values from the same object which configures the Posts Generator, at a sub-object for that page's group.

posts.postPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.

posts.allPages Site Config

Configure this item with additional options merged in from config.yml, from the object at the archetype key. Dots in the key indicate sub-objects within the site config.