all
Selects the configuration options available for all three output formats.
This means that it only contains the options that exist in all three formats, for anything specific to one or two formats you need to use their respective selectors.
Attributes
- Graph
-
- Supertypes
-
class Objecttrait Matchableclass Any
- Self type
-
all.type
Members list
Value members
Inherited methods
Specifies which font family to use for the body text, for headlines and for inline code and code blocks.
Specifies which font family to use for the body text, for headlines and for inline code and code blocks.
All specified fonts need to be made available for the theme first by using the fontResources method. The body font needs to be available at least as regular, italic, bold and bold italic. The headline font needs to support bold and bold italic. For the code font a regular font weight is sufficient.
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Adds one or more font resources to the theme, either based on a local classpath or file system resource, or a web font URL, or both.
Adds one or more font resources to the theme, either based on a local classpath or file system resource, or a web font URL, or both.
E-book formats like EPUB or PDF require a local font file to be available for embedding. A web font URL can only be used for website generation.
When using this method, all default fonts of the Helium theme will be de-registered.
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Configure the theme's font sizes. Most property names are self-explanatory, the small font is currently only used for footnote references in PDF output.
Configure the theme's font sizes. Most property names are self-explanatory, the small font is currently only used for footnote references in PDF output.
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Configures the colors of runtime messages embedded in the rendered result. Warnings and errors will only be rendered if you change the configuration to visual debugging, by default the presence of errors will lead to the abortion of the process. See the section "Visual Debugging" on the Configuration page in the manual for details.
Configures the colors of runtime messages embedded in the rendered result. Warnings and errors will only be rendered if you change the configuration to visual debugging, by default the presence of errors will lead to the abortion of the process. See the section "Visual Debugging" on the Configuration page in the manual for details.
Value parameters
- error
-
the text color for error-level messages
- errorLight
-
the background color for error-level messages
- info
-
the text color for info-level messages
- infoLight
-
the background color for info-level messages
- warning
-
the text color for warning-level messages
- warningLight
-
the background color for warning-level messages
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Allows to define a small set of metadata that describes the output.
Allows to define a small set of metadata that describes the output.
In the generated site it will be used to populate the <head> section of the HTML output, for EPUB and PDF it will be used to embed the information into the generated files in a way that the respective readers understand.
When using the sbt plugin the title, description and version metadata will be pre-populated by the standard sbt settings name, description and version respectively. When using the library API no medata will be defined by default. It is recommended to always define the language and title as the minimum set of metadata.
Value parameters
- authors
-
one or more author names
- dateModified
-
the modification date as a UTC date-time
- datePublished
-
the publication date as a UTC date-time
- description
-
a short description of the site and/or e-book
- identifier
-
a unique identifier for the e-book, not used for site generation
- language
-
the language of the site and/or e-book, should always be defined
- title
-
the title of the site and/or e-book
- version
-
the version string for the output
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Specifies two sets of five colors each to be used by Laika's support for syntax highlighting.
Specifies two sets of five colors each to be used by Laika's support for syntax highlighting.
If you use the built-in highlighters (which are based on Laika's own parsers) the display is based on a 10-color scheme with 5 base colors which are usually grayish/low saturation and 5 "wheel" colors which are usually placed around the color wheel.
If you use external tools like highlight.js these settings will have no effect and you need to use the styling mechanism of that 3rd-party tool.
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Adds a dedicated page for a table of content, in addition to the reader-native navigation structure.
Adds a dedicated page for a table of content, in addition to the reader-native navigation structure.
Value parameters
- depth
-
the navigation depth which may be different than the one for the reader-native navigation structure
- title
-
the title to display on the page and in navigation that links to the page
Attributes
- Inherited from:
- AllFormatsOps (hidden)
Configures the four main colors used by the theme.
Configures the four main colors used by the theme.
Value parameters
- background
-
the background color of the pages
- bgGradient
-
specifies two colors to be used as background gradient, currently only used on the landing page
- primary
-
this color is used for headlines, navigation highlights and other decorative elements
- primaryLight
-
is supposed to be a lighter shade of the primary color and is used for the background color of sidebars and other decorated blocks; ensure that the text in the
primarycolor is readable when placed on aprimaryLightbackground - primaryMedium
-
is supposed to be a shade between primary and primaryLight and is used for borders and text on the landing page (on dark background)
- secondary
-
this color is used for navigation headers and links
- text
-
the color of the body text
Attributes
- Inherited from:
- AllFormatsOps (hidden)