epub

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.

For inclusion in EPUB document a special suffix is expected:

• .shared.css for CSS documents to be auto-linked for EPUB and the website
• .epub.css for CSS document to be auto-linked only for EPUB, but not the website

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 one or more cover images for the EPUB document.

Multiple cover images are only relevant when the @:select directive is used to generate different versions of the same e-book which can all have their own cover image. See the documentation for the @:select directive in the chapter "Standard Directives" in the manual for details.

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

Allows to override the defaults for Helium's EPUB 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.

Most arguments should be self-explanatory. The keepTogetherDecoratedLines value controls the number of lines for decorated blocks like code examples or callouts that should always be kept on the same page. With a setting of 12 for example only blocks with more than 12 lines are allowed to be split across multiple pages. If you choose very high numbers for this setting you might see pages with a lot of blank space when it has to move a large block to the next page.

The navigation depth of the main navigation structure provided to the EPUB reader. The depth value counts all elements that form the hierarchy, directories, documents and sections within documents.

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