Packages

abstract class Theme extends Logging

Base class for themes.

Linear Supertypes
Logging, AnyRef, Any
Known Subclasses
Clean, Dump, HtmlTheme, DefaultTheme, PdfTheme
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Theme
  2. Logging
  3. AnyRef
  4. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Theme(global: Global)

Abstract Value Members

  1. abstract def render(site: Site): Unit

    Render the site.

    Render the site. May create additional synthetic pages and copy resources on demand.

Concrete Value Members

  1. def build: Unit

    The full pipeline for building the site.

  2. def buildAllPages: Vector[Page]

    Get all source pages and synthetic pages

  3. val global: Global
  4. final def logTime[T](msg: String)(f: ⇒ T): T
    Definition Classes
    Logging
  5. val logger: Logger
    Definition Classes
    Logging
  6. def noHighlightLanguages(p: Page): Set[String]

    The language codes that should not be processed by a highlighter.

  7. def resolveResource(uri: URI): URI

    Resolve a resource URI to a source file location.

    Resolve a resource URI to a source file location. Resource URIs can use use the following protocols: file, site (static site resources), webjar (absolute WebJar resource), theme (relative to theme class), classpath (relative to classpath root), template (generated from template)

  8. def specialImageSchemesBlock: Set[String]

    Extra image URI schemes to turn into SpecialImage nodes for rendering in block contexts

  9. def specialImageSchemesInline: Set[String]

    Extra image URI schemes to turn into SpecialImage nodes for rendering in inline contexts

  10. def suggestRelativePath(uri: URI): String

    Get a default relative path for a resource URI

  11. def synthesizePages(missingSyntheticPages: Vector[(String, URI)]): Vector[Page]

    Synthesize configured synthetic pages pre-TOC.

    Synthesize configured synthetic pages pre-TOC. Not all requested pages have to be created but only the ones that are returned will be available for resolving the TOC.