ThirdPartyLibrary

sealed class ThirdPartyLibrary

Single source of truth for a third-party library bundled in the HTML output.

Parameters

names

the library directory name under lib/ in the output

headContributions

the HTML <head> elements this library requires

See also

Inheritors

Types

Link copied to clipboard

Bootstrap Icons: icon font used throughout the UI. Always included.

Link copied to clipboard
object Companion
Link copied to clipboard

Highlight.js and its plugins for syntax highlighting of code blocks. The hljs color theme CSS is inlined into color themes at SCSS compile time, so no theme stylesheet is emitted here.

Link copied to clipboard
data object KaTeX : ThirdPartyLibrary

KaTeX for rendering math expressions.

Link copied to clipboard

Mermaid for rendering diagrams.

Link copied to clipboard

Paged.js polyfill for paged (book/article) documents.

Link copied to clipboard

Reveal.js for slide-based presentations.

Properties

Link copied to clipboard
Link copied to clipboard

Functions

Link copied to clipboard
abstract fun isRequired(context: Context): Boolean

Whether this library should be included in the output for the given rendering context.