laika-io
API
Generated with
laika-io/laika/laika.theme/laika.theme.config/Font

Font

laika.theme.config.Font$
See theFont companion class
object Font

Companion for creating Font instances.

Operations can be chained, e.g. by calling Font.embedFile(...).webCSS(...) if both need to be provided. The final FontDefinition instance that can be used in Laika's and Helium's configuration can be obtained by calling definedAs in the end, where the font resource is mapped to a family name, font weight and style.

Attributes

Companion
class
Graph
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Font.type

Members list

Type members

Inherited types

type MirroredElemLabels <: Tuple

The names of the product elements

The names of the product elements

Attributes

Inherited from:
Mirror
type MirroredLabel <: String

The name of the type

The name of the type

Attributes

Inherited from:
Mirror

Value members

Concrete methods

def embedFile(name: String): Font

Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

Attributes

def embedFile(file: FilePath): Font

Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

Specifies a font file that can be used for embedding in EPUB or PDF. This is one of the few places in Laika where a real file-system path needs to be provided, not a path from the library's virtual path.

Attributes

def embedResource(name: String): Font

Specifies a font file as a classpath resource that can be used for embedding in EPUB or PDF. For theme authors classpath resources are the recommended way of providing default fonts.

Specifies a font file as a classpath resource that can be used for embedding in EPUB or PDF. For theme authors classpath resources are the recommended way of providing default fonts.

Attributes

def webCSS(url: String): Font

Specifies a URL for a web font which can be auto-linked in a theme template.

Specifies a URL for a web font which can be auto-linked in a theme template.

Attributes

Deprecated methods

def embedFile(file: File): Font

Attributes

Deprecated
true
Generated with