Changelog

Track changes and create references to all versions of your project.

Default Config
# config.yml
...
changelog:
  baseDir: changelog
  format: {major}.{minor}.{patch}
  includeMinorVersions: false
  orderBy: {}
or
# config/changelog.yml
baseDir: changelog
format: {major}.{minor}.{patch}
includeMinorVersions: false
orderBy: {}
Key Type Default Value Description
baseDir String changelog

The base directory in local resources to look for changelog entries in.

format String {major}.{minor}.{patch}

The format your changelog version follow.

includeMinorVersions boolean false

Whether to include minor versions in the version list.

orderBy JSONObject {}

The properties of your format to order by as keys, with their type as values. The values should be one of [string, number]

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.

Changelog

Display the full changelog

110: [changelog]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "changelog"
No options
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.

Changelog Versions

Show a list of all versions in your changelog

100: [changelogVersionPicker]

Basic Usage
# a page's Front Matter, or in any option of type ComponentHolder
...
components:
  - type: "changelogVersionPicker"
No options
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.

Changelog Version

Key Type Default Value Description
major boolean false

Whether this is a major version.

minor boolean false

Whether this is a minor version.

url String empty string

The URL that hosts the documentation for this specific version

version String empty string

The name of the version

No options

GithubReleases

Create releases directly on Github.

Default Config
# config.yml
...
services:
  publications:
    stages:
      githubReleases:
        repo: empty string
Key Type Default Value Description
repo String empty string

The repository to release to, as [username/repo].

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

All options passed to this object.

dry boolean false
order int 0

Manually set the order in which this publisher executes

Required Changelog Version Publisher

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

All options passed to this object.

dry boolean false
order int 0

Manually set the order in which this publisher executes