Packages

class DefaultTheme extends HtmlTheme

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

Instance Constructors

  1. new DefaultTheme(global: Global)

Type Members

  1. type ResourceTemplate = Template1[HtmlSiteModel, play.twirl.api.TxtFormat.Appendable]
    Definition Classes
    HtmlTheme
  2. type Template = Template1[HtmlPageModel, play.twirl.api.HtmlFormat.Appendable]
    Definition Classes
    HtmlTheme

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.

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

    Definition Classes
    HtmlTheme
  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): DefaultPageContext
    Definition Classes
    DefaultTheme → HtmlTheme
  10. def createPageModel(pc: HtmlPageContext, renderer: HtmlRenderer): DefaultPageModel
    Definition Classes
    DefaultTheme → HtmlTheme
  11. def createSearchIndex(site: Site): Unit
    Attributes
    protected
    Definition Classes
    HtmlTheme
  12. def createSiteContext(site: Site): HtmlSiteContext
    Definition Classes
    HtmlTheme
  13. def createSiteModel(pms: Vector[HtmlPageModel]): HtmlSiteModel
    Definition Classes
    DefaultTheme → HtmlTheme
  14. val defaultNoHighlightLanguages: Set[String]
    Definition Classes
    HtmlTheme
  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. lazy val fontAwesome: Map[String, String]
  19. def generateSourceLinkText(uri: String): String
  20. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  21. def getResourceTemplate(name: String): ResourceTemplate
    Definition Classes
    HtmlTheme
  22. def getTemplate(name: String): Template
    Definition Classes
    HtmlTheme
  23. val global: Global
    Definition Classes
    Theme
  24. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  25. val indexPage: Option[String]
    Definition Classes
    HtmlTheme
  26. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  27. final def logTime[T](msg: String)(f: ⇒ T): T
    Definition Classes
    Logging
  28. val logger: Logger
    Definition Classes
    Logging
  29. val mathJaxExclude: FileMatcher
    Definition Classes
    HtmlTheme
  30. val mermaidJS: String
    Definition Classes
    HtmlTheme
  31. val minifyCSS: Boolean
    Definition Classes
    HtmlTheme
  32. val minifyHTML: Boolean
    Definition Classes
    HtmlTheme
  33. val minifyJS: Boolean
    Definition Classes
    HtmlTheme
  34. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  35. 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
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. 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
  39. def renderAttributedBlockQuote(n: AttributedBlockQuote, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  40. 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.

    Definition Classes
    DefaultTheme → HtmlTheme
  41. 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.

    Definition Classes
    DefaultTheme → HtmlTheme
  42. def renderEmoji(pc: HtmlPageContext)(n: Emoji, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  43. def renderFencedCodeBlock(pc: HtmlPageContext)(n: AttributedFencedCodeBlock, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  44. def renderHighlitBlock(pc: HtmlPageContext)(n: HighlitBlock, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  45. def renderHighlitInline(pc: HtmlPageContext)(n: HighlitInline, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  46. def renderIndentedCodeBlock(pc: HtmlPageContext)(n: IndentedCodeBlock, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  47. def renderIndexBlock(pc: HtmlPageContext)(n: IndexBlock, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  48. def renderInlineCode(pc: HtmlPageContext)(n: Code, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  49. def renderInlineMath(pc: HtmlPageContext)(n: InlineMath, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  50. 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.

    Definition Classes
    HtmlTheme
  51. def renderMathBlock(pc: HtmlPageContext)(n: MathBlock, c: HtmlNodeRendererContext): Unit
    Definition Classes
    HtmlTheme
  52. 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).

    Definition Classes
    DefaultTheme → HtmlTheme
  53. def renderSpecialImageBlock(pc: HtmlPageContext)(n: SpecialImageBlock, c: HtmlNodeRendererContext): Unit

    This method should be overridden if specialImageSchemesBlock is used.

    This method should be overridden if specialImageSchemesBlock is used.

    Definition Classes
    HtmlTheme
  54. def renderSpecialImageInline(pc: HtmlPageContext)(n: SpecialImageInline, c: HtmlNodeRendererContext): Unit

    This method should be overridden if specialImageSchemesInline is used.

    This method should be overridden if specialImageSchemesInline is used.

    Definition Classes
    DefaultTheme → HtmlTheme
  55. 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.

    Definition Classes
    DefaultTheme → HtmlTheme
  56. def renderTableBlock(n: TableBlock, c: HtmlNodeRendererContext): Unit
  57. def renderers(pc: HtmlPageContext): Seq[HtmlNodeRendererFactory]
    Definition Classes
    DefaultTheme → HtmlTheme
  58. 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
  59. 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
  60. 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
    DefaultTheme → Theme
  61. val suffix: String
    Definition Classes
    HtmlTheme
  62. 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
  63. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  64. 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
    DefaultTheme → Theme
  65. 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
  66. def targetDir: File
    Definition Classes
    HtmlTheme
  67. def targetFile(uri: URI): File
    Definition Classes
    HtmlTheme
  68. val tc: Config
    Definition Classes
    HtmlTheme
  69. def toString(): String
    Definition Classes
    AnyRef → Any
  70. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  71. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  72. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @throws( ... )

Inherited from HtmlTheme

Inherited from Theme

Inherited from Logging

Inherited from AnyRef

Inherited from Any

Ungrouped