See Also:

Edit this page

API Documentation

Kotlin

Creates a page for each Class and Package in your project, displaying the expected KDoc information of methods, fields, etc. but in your site's theme.

Default Config
# config.yml
...
kotlindoc:
  sourceDirs: [../../main/kotlin]
or
# config/kotlindoc.yml
sourceDirs: [../../main/kotlin]
Key Type Default Value Description
sourceDirs List<String> [../../main/kotlin]
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.

Java

Creates a page for each Class and Package in your project, displaying the expected Javadoc information of methods, fields, etc. but in your site's theme.

Default Config
# config.yml
...
javadoc:
  sourceDirs: [../../main/java]
or
# config/javadoc.yml
sourceDirs: [../../main/java]
Key Type Default Value Description
sourceDirs List<String> [../../main/java]
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.

Swift

Generate documentation from Swift code and comments with the help of SourceKitten. It's like Javadoc, but for Swift!

Default Config
# config.yml
...
swiftdoc:
  baseDir: swift
or
# config/swiftdoc.yml
baseDir: swift
Key Type Default Value Description
baseDir String swift

The base directory in local resources to look for swift source code in.

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.