class Dump extends Theme
A theme that prints the document structure to stdout.
- Alphabetic
- By Inheritance
- Dump
- Theme
- Logging
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
build: Unit
The full pipeline for building the site.
The full pipeline for building the site.
- Definition Classes
- Theme
-
def
buildAllPages: Vector[Page]
Get all source pages and synthetic pages
Get all source pages and synthetic pages
- Definition Classes
- Theme
-
def
clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
val
global: Global
- Definition Classes
- Theme
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
final
def
logTime[T](msg: String)(f: ⇒ T): T
- Definition Classes
- Logging
-
val
logger: Logger
- Definition Classes
- Logging
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
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
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
render(site: Site): Unit
Render the site.
-
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
-
def
specialImageSchemesBlock: Set[String]
Extra image URI schemes to turn into
SpecialImage
nodes for rendering in block contextsExtra image URI schemes to turn into
SpecialImage
nodes for rendering in block contexts- Definition Classes
- Theme
-
def
specialImageSchemesInline: Set[String]
Extra image URI schemes to turn into
SpecialImage
nodes for rendering in inline contextsExtra image URI schemes to turn into
SpecialImage
nodes for rendering in inline contexts- Definition Classes
- Theme
-
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
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
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
-
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
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @throws( ... )