laika.helium.config

Type members

Classlikes

sealed trait AnchorPlacement

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

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

Companion:
object
Companion:
class
sealed abstract case class ButtonLink(target: Target, text: String, icon: Option[Icon], options: Options) extends SingleTargetLink

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

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

Companion:
object
object ButtonLink
Companion:
class
case class ColorQuintet(c1: Color, c2: Color, c3: Color, c4: Color, c5: Color)

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.

final case class DynamicHomeLink(options: Options) extends ThemeLinkSpan

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

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

Companion:
object
Companion:
class
case class Favicon

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.

Companion:
object
object Favicon

Companion for creating Favicon configuration instances.

Companion for creating Favicon configuration instances.

Companion:
class
object HeliumIcon

Enumeration for using any of the icons provided by the Helium theme out of the box in the theme configuration.

Enumeration for using any of the icons provided by the Helium theme out of the box in the theme configuration.

Several options like those for the landing page or the top navigation bar allow the addition of icon links where these pre-built selection can be used.

They are based on the icofont which is licensed under the Open Font license and part of the laika-io artifact.

sealed abstract case class IconLink(target: Target, icon: Icon, text: Option[String], options: Options) extends SingleTargetLink

A link consisting of an icon and optional text.

A link consisting of an icon and optional text.

Companion:
object
object IconLink
Companion:
class
sealed abstract case class ImageLink(target: Target, image: Image, options: Options) extends SingleTargetLink

A simple image link.

A simple image link.

Companion:
object
object ImageLink
Companion:
class
sealed abstract case class LinkGroup(links: Seq[SingleTargetLink], options: Options) extends ThemeLinkSpan with MultiTargetLink

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.

Companion:
object
object LinkGroup
Companion:
class
sealed abstract case class Menu(label: Seq[Span], links: Seq[SingleTargetLink], options: Options) extends ThemeLinkBlock with MultiTargetLink

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

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

Companion:
object
object Menu
Companion:
class
sealed trait MultiTargetLink extends ThemeLink
case class ReleaseInfo(title: String, version: String)

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.

Value parameters:
title

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

version

the version number of the release

sealed trait SingleTargetLink extends ThemeLinkSpan
case class Teaser(title: String, description: String)

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

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

sealed abstract case class TextLink(target: Target, text: String, options: Options) extends SingleTargetLink

A simple text link.

A simple text link.

Companion:
object
object TextLink
Companion:
class
sealed trait ThemeLink extends Unresolved

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

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

sealed trait ThemeLinkBlock extends ThemeLink with BlockResolver
sealed trait ThemeLinkSpan extends ThemeLink with SpanResolver
final case class ThemeNavigationSection(title: String, links: NonEmptyList[TextLink])
Companion:
object
sealed abstract case class VersionMenu(versionedLabelPrefix: String, unversionedLabel: String, links: Seq[SingleTargetLink], options: Options) extends ThemeLinkBlock with MultiTargetLink
Companion:
object
Companion:
class