Value Members

1.  final def !=(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

2.  final def ##(): Int

   Definition Classes

   AnyRef → Any

3.  final def ==(arg0: Any): Boolean

   Definition Classes

   AnyRef → Any

4.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

5.  def autoLinkCSS(paths: Path*): Helium

   Auto-links CSS documents from the specified paths.

   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

   Definition Classes

   EPUBOps

6.  def autoLinkJS(paths: Path*): Helium

   Auto-links JavaScript documents from the specified paths.

   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.

   Definition Classes

   EPUBOps

7.  def clone(): AnyRef

   Attributes

   protected[lang]

   Definition Classes

   AnyRef

   Annotations

   @throws( ... ) @native()

8.  def copyWith(pdfSettings: PDFSettings): Helium

   Attributes

   protected

   Definition Classes

   CopyOps

9.  def copyWith(epubSettings: EPUBSettings): Helium

   Attributes

   protected

   Definition Classes

   CopyOps

10.  def copyWith(siteSettings: SiteSettings): Helium

    Attributes

    protected

    Definition Classes

    CopyOps

11.  def coverImages(images: CoverImage*): Helium

    Specifies one or more cover images for the EPUB document.

    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.

    Definition Classes

    EPUBOps

12.  def currentColors: ColorSet

    Attributes

    protected

    Definition Classes

    EPUBOps → ColorOps

13.  def darkMode: DarkModeOps

    Allows to add a second color set for dark mode.

    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.

    Definition Classes

    EPUBOps

14.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

15.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

16.  def finalize(): Unit

    Attributes

    protected[lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

17.  def fontFamilies(body: String, headlines: String, code: String): Helium

    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.

    Definition Classes

    SingleConfigOps → CommonConfigOps

18.  def fontResources(defn: FontDefinition*): Helium

    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.

    Definition Classes

    EPUBOps → SingleConfigOps → CommonConfigOps

19.  def fontSizes(body: Length, code: Length, title: Length, header2: Length, header3: Length, header4: Length, small: Length): Helium

    Configure the theme's font sizes.

    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.

    Definition Classes

    SingleConfigOps → CommonConfigOps

20.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

21.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

22.  def helium: Helium

    Attributes

    protected

    Definition Classes

    epub → CopyOps

23.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

24.  def layout(defaultBlockSpacing: Length, defaultLineHeight: Double, keepTogetherDecoratedLines: Int): Helium

    Allows to override the defaults for Helium's EPUB layout.

    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.

    Definition Classes

    EPUBOps

25.  def messageColors(info: Color, infoLight: Color, warning: Color, warningLight: Color, error: Color, errorLight: Color): Helium

    Definition Classes

    ColorOps

26.  def metadata(title: Option[String] = None, description: Option[String] = None, identifier: Option[String] = None, authors: Seq[String] = Nil, language: Option[String] = None, date: Option[Instant] = None, version: Option[String] = None): Helium

    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.

    title

    the title of the site and/or e-book

    description

    a short description of the site and/or e-book

    identifier

    a unique identifier for the e-book, not used for site generation

    authors

    one or more author names

    language

    the language of the site and/or e-book, should always be defined

    date

    the publication date as a UTC date-time

    version

    the version string for the output

    Definition Classes

    SingleConfigOps → CommonConfigOps

27.  def navigationDepth(depth: Int): Helium

    The navigation depth of the main navigation structure provided to the EPUB reader.

    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.

    Definition Classes

    EPUBOps

28.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

29.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

30.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

31.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

32.  def syntaxHighlightingColors(base: ColorQuintet, wheel: ColorQuintet): Helium

    Definition Classes

    ColorOps

33.  def tableOfContent(title: String, depth: Int): Helium

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

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

    title

    the title to display on the page and in navigation that links to the page

    depth

    the navigation depth which may be different than the one for the navigation bar

    Definition Classes

    EPUBOps → CommonConfigOps

34.  def themeColors(primary: Color, primaryMedium: Color, primaryLight: Color, secondary: Color, text: Color, background: Color, bgGradient: (Color, Color)): Helium

    Definition Classes

    ColorOps

35.  def toString(): String

    Definition Classes

    AnyRef → Any

36.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

37.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

38.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... ) @native()

39.  def withColors(colors: ColorSet): Helium

    Attributes

    protected

    Definition Classes

    EPUBOps → SingleConfigOps → ColorOps

40.  def withFontFamilies(fonts: ThemeFonts): Helium

    Attributes

    protected

    Definition Classes

    EPUBOps → SingleConfigOps

41.  def withFontSizes(sizes: FontSizes): Helium

    Attributes

    protected

    Definition Classes

    EPUBOps → SingleConfigOps

42.  def withMetadata(metadata: DocumentMetadata): Helium

    Attributes

    protected

    Definition Classes

    EPUBOps → SingleConfigOps