Packages

p

laika

rewrite

package rewrite

Ordering
  1. Alphabetic
Visibility
  1. Public
  2. All

Type Members

  1. case class ReferenceResolver(config: Config) extends Product with Serializable

    A resolver for context references in templates or markup documents.

  2. case class TemplateContext(templateSuffix: String, finalFormat: String) extends Product with Serializable
  3. trait TemplateRewriter extends AnyRef
  4. case class Version(displayValue: String, pathSegment: String, fallbackLink: String = "index.html", label: Option[String] = None) extends Product with Serializable

    Configuration for a single version of the documentation.

    Configuration for a single version of the documentation.

    displayValue

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

    pathSegment

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

    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)

  5. case class Versions(currentVersion: Version, olderVersions: Seq[Version], newerVersions: Seq[Version] = Nil, excludeFromScanning: Seq[Path] = Nil) extends Product with Serializable

    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).

    currentVersion

    the version that the sources of a transformation produce

    olderVersions

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

    newerVersions

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

    excludeFromScanning

    paths to be skipped when scanning the output directory for existing versions (e.g. for API docs)

Value Members

  1. object DefaultTemplatePath

    Provides the paths for default templates for all formats.

  2. object ReferenceResolver extends Serializable

    Companion for constructing ReferenceResolvers for a particular target Document.

  3. object TemplateContext extends Serializable
  4. object TemplateRewriter extends TemplateRewriter
  5. object Version extends Serializable
  6. object Versions extends Serializable

Ungrouped