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.  def addMathJaxResources(pc: HtmlPageContext): Option[(URI, Option[ConfigObject])]

   If MathJax is needed by the page, add all resources and return the resolved main script URI and inline config.

5.  final def asInstanceOf[T0]: T0

   Definition Classes

   Any

6.  def build: Unit

   The full pipeline for building the site.

   The full pipeline for building the site.

   Definition Classes

   Theme

7.  def buildAllPages: Vector[Page]

   Get all source pages and synthetic pages

   Get all source pages and synthetic pages

   Definition Classes

   Theme

8.  def clone(): AnyRef

   Attributes

   protected[java.lang]

   Definition Classes

   AnyRef

   Annotations

   @native() @throws( ... )

9.  def createPageContext(siteContext: HtmlSiteContext, page: Page): HtmlPageContext
10.  def createPageModel(pc: HtmlPageContext, renderer: HtmlRenderer): HtmlPageModel
11.  def createSearchIndex(site: Site): Unit

    Attributes

    protected

12.  def createSiteContext(site: Site): HtmlSiteContext
13.  def createSiteModel(pms: Vector[HtmlPageModel]): HtmlSiteModel
14.  val defaultNoHighlightLanguages: Set[String]
15.  final def eq(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

16.  def equals(arg0: Any): Boolean

    Definition Classes

    AnyRef → Any

17.  def finalize(): Unit

    Attributes

    protected[java.lang]

    Definition Classes

    AnyRef

    Annotations

    @throws( classOf[java.lang.Throwable] )

18.  final def getClass(): Class[_]

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

19.  def getResourceTemplate(name: String): ResourceTemplate
20.  def getTemplate(name: String): Template
21.  val global: Global

    Definition Classes

    Theme

22.  def hashCode(): Int

    Definition Classes

    AnyRef → Any

    Annotations

    @native()

23.  val indexPage: Option[String]
24.  final def isInstanceOf[T0]: Boolean

    Definition Classes

    Any

25.  final def logTime[T](msg: String)(f: ⇒ T): T

    Definition Classes

    Logging

26.  val logger: Logger

    Definition Classes

    Logging

27.  val mathJaxExclude: FileMatcher
28.  val mermaidJS: String
29.  val minifyCSS: Boolean
30.  val minifyHTML: Boolean
31.  val minifyJS: Boolean
32.  final def ne(arg0: AnyRef): Boolean

    Definition Classes

    AnyRef

33.  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

    HtmlTheme → Theme

34.  final def notify(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

35.  final def notifyAll(): Unit

    Definition Classes

    AnyRef

    Annotations

    @native()

36.  def render(site: Site): Unit

    Render the site.

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

    Definition Classes

    HtmlTheme → Theme

37.  def renderAttributedBlockQuote(n: AttributedBlockQuote, c: HtmlNodeRendererContext): Unit
38.  def renderAttributedHeading(pc: HtmlPageContext)(n: AttributedHeading, c: HtmlNodeRendererContext): Unit

    Render a heading with an ID.

    Render a heading with an ID. It can be overridden in subclasses as needed.

39.  def renderCode(hlr: HighlightResult, code: Node, c: HtmlNodeRendererContext, pc: HtmlPageContext): Unit

    Render code that was run through the highlighter.

    Render code that was run through the highlighter. This method is called for all fenced code blocks, indented code blocks and inline code. It can be overridden in subclasses as needed.

40.  def renderEmoji(pc: HtmlPageContext)(n: Emoji, c: HtmlNodeRendererContext): Unit
41.  def renderFencedCodeBlock(pc: HtmlPageContext)(n: AttributedFencedCodeBlock, c: HtmlNodeRendererContext): Unit
42.  def renderHighlitBlock(pc: HtmlPageContext)(n: HighlitBlock, c: HtmlNodeRendererContext): Unit
43.  def renderHighlitInline(pc: HtmlPageContext)(n: HighlitInline, c: HtmlNodeRendererContext): Unit
44.  def renderIndentedCodeBlock(pc: HtmlPageContext)(n: IndentedCodeBlock, c: HtmlNodeRendererContext): Unit
45.  def renderIndexBlock(pc: HtmlPageContext)(n: IndexBlock, c: HtmlNodeRendererContext): Unit
46.  def renderInlineCode(pc: HtmlPageContext)(n: Code, c: HtmlNodeRendererContext): Unit
47.  def renderInlineMath(pc: HtmlPageContext)(n: InlineMath, c: HtmlNodeRendererContext): Unit
48.  def renderMath(code: String, c: HtmlNodeRendererContext, pc: HtmlPageContext, mathType: String, block: Boolean): Unit

    Render a TeX math, MML or ASCIIMath block or inline element.

    Render a TeX math, MML or ASCIIMath block or inline element. The default implementation puts the code into a "script" element with the proper language code (which should be one of "tex", "asciimath" and "mml"). Inline elements get a preceding "MathJax_Preview" span element, for block elements this is created as a div and a "mode=display" annotation is added to the script.

49.  def renderMathBlock(pc: HtmlPageContext)(n: MathBlock, c: HtmlNodeRendererContext): Unit
50.  def renderMermaid(n: AttributedFencedCodeBlock, c: HtmlNodeRendererContext, pc: HtmlPageContext): Unit

    Render a Mermaid diagram block.

    Render a Mermaid diagram block. This does not add any dependency on Mermaid to the generated site. The method should be overwritten accordingly (unless a theme always adds it anyway).

51.  def renderSpecialImageBlock(pc: HtmlPageContext)(n: SpecialImageBlock, c: HtmlNodeRendererContext): Unit

    This method should be overridden if specialImageSchemesBlock is used.

52.  def renderSpecialImageInline(pc: HtmlPageContext)(n: SpecialImageInline, c: HtmlNodeRendererContext): Unit

    This method should be overridden if specialImageSchemesInline is used.

53.  def renderTabView(pc: HtmlPageContext)(n: TabView, c: HtmlNodeRendererContext): Unit

    Render a tab view.

    Render a tab view. The default implementation simply renders the content so that merged code blocks look no different than regular code blocks. Themes can override this method to render the actual tab view.

54.  def renderers(pc: HtmlPageContext): Seq[HtmlNodeRendererFactory]
55.  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

56.  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

57.  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

58.  val suffix: String
59.  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

60.  final def synchronized[T0](arg0: ⇒ T0): T0

    Definition Classes

    AnyRef

61.  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

62.  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

63.  def targetDir: File
64.  def targetFile(uri: URI): File
65.  val tc: Config
66.  def toString(): String

    Definition Classes

    AnyRef → Any

67.  final def wait(): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

68.  final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes

    AnyRef

    Annotations

    @throws( ... )

69.  final def wait(arg0: Long): Unit

    Definition Classes

    AnyRef

    Annotations

    @native() @throws( ... )