com.eden.orchid.kotlindoc.KotlindocGenerator


Own Options

Type Default Value Description
sourceDirs List [../../main/kotlin]

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.kotlindoc.helpers.KotlindocInvokerImpl


Own Options

Inherited Options

com.eden.orchid.kotlindoc.menu.AllClassesMenuItemType


Own Options

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.kotlindoc.menu.AllPackagesMenuItemType


Own Options

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.kotlindoc.menu.KotlinClassDocLinksMenuItemType


Own Options

Type Default Value Description
includeItems boolean false Whether to include the items for each category. For example, including a menu item for each individual constructor as children of 'Constructors' or just a link to the Constructors section.

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.kotlindoc.page.BaseKotlindocPage


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.
next PageRelation com.eden.orchid.impl.relations.PageRelation@474c5d3
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@37b45722
previous PageRelation com.eden.orchid.impl.relations.PageRelation@3e56215
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.kotlindoc.page.KotlindocClassPage


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.
next PageRelation com.eden.orchid.impl.relations.PageRelation@1e2980c7
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@b31cbc4
previous PageRelation com.eden.orchid.impl.relations.PageRelation@3cd1848c
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.kotlindoc.page.KotlindocPackagePage


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.
next PageRelation com.eden.orchid.impl.relations.PageRelation@245b679
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@73dea62f
previous PageRelation com.eden.orchid.impl.relations.PageRelation@22d001d4
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.