See Also:

Edit this page

API Documentation

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.