Packages

class Dump extends Theme

A theme that prints the document structure to stdout.

Linear Supertypes
Theme, Logging, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Dump
  2. Theme
  3. Logging
  4. AnyRef
  5. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new Dump(global: Global)

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def build: Unit

    The full pipeline for building the site.

    The full pipeline for building the site.

    Definition Classes
    Theme
  6. def buildAllPages: Vector[Page]

    Get all source pages and synthetic pages

    Get all source pages and synthetic pages

    Definition Classes
    Theme
  7. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )
  8. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  9. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  10. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  11. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  12. val global: Global
    Definition Classes
    Theme
  13. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  14. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  15. final def logTime[T](msg: String)(f: ⇒ T): T
    Definition Classes
    Logging
  16. val logger: Logger
    Definition Classes
    Logging
  17. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  18. def noHighlightLanguages(p: Page): Set[String]

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

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

    Definition Classes
    Theme
  19. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  20. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  21. def render(site: Site): Unit

    Render the site.

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

    Definition Classes
    DumpTheme
  22. 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)

    Definition Classes
    Theme
  23. def specialImageSchemesBlock: Set[String]

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

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

    Definition Classes
    Theme
  24. def specialImageSchemesInline: Set[String]

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

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

    Definition Classes
    Theme
  25. def suggestRelativePath(uri: URI): String

    Get a default relative path for a resource URI

    Get a default relative path for a resource URI

    Definition Classes
    Theme
  26. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  27. 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.

    Definition Classes
    Theme
  28. def syntheticPageURIs: Vector[(String, URI)]

    Get synthetic page names and the mapped URIs for pages that should be created by the theme.

    Get synthetic page names and the mapped URIs for pages that should be created by the theme. Any pages that have to be created before resolving the TOC should be part of this.

    Attributes
    protected
    Definition Classes
    Theme
  29. def toString(): String
    Definition Classes
    AnyRef → Any
  30. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  31. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  32. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from Theme

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped