Type Members

1.  sealed trait AnchorPlacement extends AnyRef

   Configures the anchor placement for section headers.

   Configures the anchor placement for section headers. Anchors appear on mouse-over and allow to copy the direct link to the section.

2.  sealed abstract case class ButtonLink extends Element with SingleTargetLink with Product with Serializable

   A link consisting of text and an optional icon, by default rendered in a rounded rectangle.

3.  case class ColorQuintet(c1: Color, c2: Color, c3: Color, c4: Color, c5: Color) extends Product with Serializable

   Specifies a set of five colors which is a grouping used in Laika's support for syntax highlighting.

   Specifies a set of five colors which is a grouping used in 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.

4.  final case class DynamicHomeLink(options: Options = NoOpt) extends Element with ThemeLinkSpan with Product with Serializable

   A home link that inserts a link to the title page of the root document tree (if available) or otherwise an invalid element.

5.  case class Favicon extends Product with Serializable

   Configuration for a single favicon which can be an internal resource or an external URL.

   Configuration for a single favicon which can be an internal resource or an external URL.

   The sizes string will be used in the corresponding sizes attribute of the generated <link> tag.

6.  sealed abstract case class IconLink extends Element with SingleTargetLink with Product with Serializable

   A link consisting of an icon and optional text.

7.  sealed abstract case class ImageLink extends Element with SingleTargetLink with Product with Serializable

   A simple image link.

8.  sealed abstract case class LinkGroup extends Element with ThemeLinkSpan with MultiTargetLink with Product with Serializable

   A generic group of theme links.

   A generic group of theme links.

   Can be used to create structures like a row of icon links in a vertical column of text links.

9.  sealed abstract case class Menu extends Element with ThemeLinkBlock with MultiTargetLink with Product with Serializable

   A menu for the top navigation bar or the landing page.

10.  sealed trait MultiTargetLink extends Element with ThemeLink
11.  case class ReleaseInfo(title: String, version: String) extends Product with Serializable

    Represents release info to be displayed on the landing page.

    Represents release info to be displayed on the landing page.

    This is specific for sites that serve as documentation for software projects.

    title

    the header above the version number, e.g. "Latest Stable Release"

    version

    the version number of the release

12.  sealed trait SingleTargetLink extends Element with ThemeLinkSpan
13.  case class Teaser(title: String, description: String) extends Product with Serializable

    Represents a single teaser block to be displayed on the landing page.

    Represents a single teaser block to be displayed on the landing page. Any number of these blocks can be passed to the Helium configuration.

14.  sealed abstract case class TextLink extends Element with SingleTargetLink with Product with Serializable

    A simple text link.

15.  sealed trait ThemeLink extends Element with Unresolved

    A Helium link type available for navigation bars and the landing page.

16.  sealed trait ThemeLinkBlock extends Element with ThemeLink with BlockResolver
17.  sealed trait ThemeLinkSpan extends Element with ThemeLink with SpanResolver
18.  final case class ThemeNavigationSection(title: String, links: NonEmptyList[TextLink]) extends Product with Serializable
19.  sealed abstract case class VersionMenu extends Element with ThemeLinkBlock with MultiTargetLink with Product with Serializable