laika-io
API
Generated with
laika-io/laika/laika.helium/laika.helium.config

laika.helium.config

package laika.helium.config

Members list

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.

Attributes

Companion
object
Supertypes
class Object
trait Matchable
class Any
Known subtypes
object Left.type
object None.type
object Right.type
object AnchorPlacement

Attributes

Companion
trait
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ButtonLink

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ButtonLink.type
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object DynamicHomeLink

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
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.

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Favicon

Companion for creating Favicon configuration instances.

Companion for creating Favicon configuration instances.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Favicon.type
object HeliumFooter

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
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.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
HeliumIcon.type
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.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object IconLink

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
IconLink.type
sealed abstract case class ImageLink(target: Target, image: Image, options: Options) extends SingleTargetLink

A simple image link.

A simple image link.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ImageLink

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
ImageLink.type
sealed abstract case class LinkGroup(links: Seq[SingleTargetLink], options: Options) extends ThemeLinkSpan, 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.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LinkGroup

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
LinkGroup.type
sealed abstract case class Menu(label: Seq[Span], links: Seq[SingleTargetLink], options: Options) extends ThemeLinkBlock, MultiTargetLink

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

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

Attributes

Companion
object
Supertypes
trait BlockResolver
trait Block
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Menu

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Menu.type
sealed trait MultiTargetLink extends ThemeLink

Attributes

Supertypes
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class LinkGroup
class Menu
class VersionMenu
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

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed trait SingleTargetLink extends ThemeLinkSpan

Attributes

Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class ButtonLink
class IconLink
class ImageLink
class TextLink
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.

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
sealed abstract case class TextLink(target: Target, text: String, options: Options) extends SingleTargetLink

A simple text link.

A simple text link.

Attributes

Companion
object
Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TextLink

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
TextLink.type
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.

Attributes

Supertypes
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class LinkGroup
class Menu
class VersionMenu
class ButtonLink
class IconLink
class ImageLink
class TextLink
Show all
sealed trait ThemeLinkBlock extends ThemeLink, BlockResolver

Attributes

Supertypes
trait BlockResolver
trait Block
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class Menu
class VersionMenu
sealed trait ThemeLinkSpan extends ThemeLink, SpanResolver

Attributes

Supertypes
trait SpanResolver
trait Span
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class LinkGroup
class ButtonLink
class IconLink
class ImageLink
class TextLink
Show all
final case class ThemeNavigationSection(title: String, links: NonEmptyList[TextLink])

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object ThemeNavigationSection

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
sealed abstract case class VersionMenu(versionedLabelPrefix: String, unversionedLabel: String, links: Seq[SingleTargetLink], options: Options) extends ThemeLinkBlock, MultiTargetLink

Attributes

Companion
object
Supertypes
trait BlockResolver
trait Block
trait ThemeLink
trait Unresolved
class Element
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object VersionMenu

Attributes

Companion
class
Supertypes
class Object
trait Matchable
class Any
Self type
Generated with