laika-core
API
Generated with
laika-core/laika/laika.rewrite

laika.rewrite

package laika.rewrite

Members list

Packages

package laika.rewrite.link
package laika.rewrite.nav

Type members

Classlikes

object DefaultTemplatePath

Provides the paths for default templates for all formats.

Provides the paths for default templates for all formats.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
case class OutputContext(fileSuffix: String, formatSelector: String)

Describes the output for a render operation.

Describes the output for a render operation.

The format selector is used by any configuration elements that allows to restrict the output of documents to certain target formats. It is not always identical to the fileSuffix used for the specific format.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class ReferenceResolver(config: Config)

A resolver for context references in templates or markup documents.

A resolver for context references in templates or markup documents.

Attributes

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

Companion for constructing ReferenceResolvers for a particular target Document.

Companion for constructing ReferenceResolvers for a particular target Document.

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Version(displayValue: String, pathSegment: String, fallbackLink: String, label: Option[String], canonical: Boolean)

Configuration for a single version of the documentation.

Configuration for a single version of the documentation.

Value parameters

canonical

indicates whether this is the canonical version

displayValue

the description of the version to use in any UI (e.g. version dropdowns)

fallbackLink

the link target to use when switching to this version from a page that does not exist in this version

label

an optional label that will be used in the UI (e.g. Dev or Stable)

pathSegment

the string to use as a path segments in URLs pointing to this version

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Version.type
case class VersionScannerConfig(rootDirectory: String, exclude: Seq[Path])

Optional configuration for scanning existing versions that had been generated by a different tool. This setting is optional and serves two purposes:

Optional configuration for scanning existing versions that had been generated by a different tool. This setting is optional and serves two purposes:

  • If older versions of the documentation had been generated by different tools, Laika can use this configuration for indexing the available paths for "smart linking", which is a feature of the Helium version switcher drop down. The result of the scanning operation will be used to populate the file /laika/versionInfo.json in the output directory.

  • If you are using the preview server (either the laikaPreview task in the sbt plugin, or the laika.preview.ServerBuilder from the API) and you want to also test the version switcher drop down menu, then Laika needs to know where older versions are located so that it can serve them, too.

The specified root directory is expected to match the structure of versioned documentation as rendered by Laika. This means that the root directory is expected to have immediate sub-directories with names that correspond to the pathSegment property of the configuration for that version.

Value parameters

exclude

paths to be skipped when scanning the output directory for existing versions (e.g. for API docs), interpreted from the root directory of each version.

rootDirectory

file system path that represents the root of existing versions.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class Versions(currentVersion: Version, olderVersions: Seq[Version], newerVersions: Seq[Version], renderUnversioned: Boolean, scannerConfig: Option[VersionScannerConfig])

Global configuration for versioned documentation.

Global configuration for versioned documentation.

The order in the Seq properties will be used for any list views in the UI (e.g. for the version chooser dropdown).

Value parameters

currentVersion

the version that the sources of a transformation produce

newerVersions

list of newer versions that have previously been rendered (may be empty)

olderVersions

list of older versions that have previously been rendered (may be empty)

renderUnversioned

indicates whether unversioned documents should be rendered (setting this to false may be useful when re-rendering older versions)

scannerConfig

optional configuration for scanning and indexing existing versions, used by the Helium version switcher dropdown and by the preview server.

Attributes

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

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
Versions.type
Generated with