site

Auto-links CSS documents from the specified paths. By default all CSS documents found anywhere in the input tree will be linked in HTML files. This setting allows to narrow it down to one or more dedicated paths within the virtual tree, which might be useful when your input contains CSS files unrelated to the pages rendered by Laika.

Auto-links JavaScript documents from the specified paths. By default all JavaScript documents found anywhere in the input tree will be linked in HTML files. This setting allows to narrow it down to one or more dedicated paths within the virtual tree, which might be useful when your input contains JavaScript files unrelated to the pages rendered by Laika.

Specifies the base URL where the rendered site will be hosted. This configuration option allows to turn internal links into external ones for documents which will be part of the rendered site, but are not included in other formats like EPUB or PDF.

Allows to add a second color set for dark mode. The implementation is based on the prefers-color-scheme media query and requires browsers supporting dark mode.

Adds a download page to the generated site that contains links to EPUB and PDF versions of the site. When the sbt plugin is used, this setting will automatically trigger the rendering of the corresponding EPUB and PDF documents when running laikaSite. When the library API is used, this setting only causes the inclusion of the download page itself, the actual EPUB and PDF content must be generated by running the respective renderers manually.

Adds one or more favicons which can be an internal resource or an external URL.

Adds a dedicated landing page to the site that is tailored for software documentation sites. By default no landing page will be included and the site will render the homepage (if present) with the same default template as the main content pages.

See the section "Website Landing Page" in the "Theme Settings" chapter for visual guide to the layout of the page.

All arguments of this method are optional, but the page would look strange if you omit most of them.

Additionally or alternatively you can also add a regular markup document called landing-page.<suffix> to one of your input directories and its content will be inserted at the bottom of this page. This is in case you want to stick with the traditional approach of some sites, which give you 'Getting Started' style content right on the start page. It can also be used to list adopters, provide a feature overview or links to presentations or videos.

Allows to override the defaults for Helium's layout. You can use the constructors found in the LengthUnit companion to create length values, e.g. LengthUnit.px(12). It's usually most convenient to import laika.ast.LengthUnit._ for your configuration code.

Adds a link to the markup source of each page on the bottom of the page navigation pane on the right side.

Adds a dedicated page for a table of content, in addition to the left navigation bar.

Configures the top navigation bar of the main content pages.

Adds a version dropdown to the top navigation bar.

The specified configuration allows to define the current version as well as any older or newer versions. For each version the pathSegment property holds the value that should use as part of URLs (e.g. /0.18/...) whereas the displayValue property holds the text that should be shown in the dropdown menu.

If the output destination of the render operation contains existing, older versions in sub-folders, those will be scanned to produce additional version information in the JSON loaded by the site. This will be used for "smart linking" where the drop-down will link to the same page of a different version if it exists.