scaladoc/dotty.tools.scaladoc.site

dotty.tools.scaladoc.site

package dotty.tools.scaladoc.site

Type members

Classlikes

object FrontMatterRenderer

Object for rendering yaml front-matter for preprocessed markdowns.

Object for rendering yaml front-matter for preprocessed markdowns.

case class LazyEntry(getKey: String, value: () => String) extends Entry[String, Object]
case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File)
case class RenderingContext(properties: Map[String, Object], layouts: Map[String, TemplateFile], resolving: Set[String], resources: List[String])
case class ResolvedPage(code: String, resources: List[String])
enum Sidebar
Companion:
object
object Sidebar
Companion:
class
class StaticSiteContext(val root: File, val args: Args, val sourceLinks: SourceLinks, val snippetCompilerArgs: SnippetCompilerArgs, val snippetChecker: SnippetChecker)(using val outerCtx: CompilerContext)
case class TemplateFile(file: File, isHtml: Boolean, rawCode: String, settings: Map[String, Object], name: String, title: TemplateName, hasFrame: Boolean, resources: List[String], layout: Option[String], configOffset: Int)

case class for the template files. Template file is a file .md or .html handling settings.

case class for the template files. Template file is a file .md or .html handling settings.

Value parameters:
file

The Actual file defining the template.

rawCode

The content, what is to be shown, everything but settings.

settings

The config defined in the begging of the file, between the pair of --- (e.g. layout: basic).

enum TemplateName(val name: String)

Value members

Concrete methods

def defaultMarkdownOptions(using ctx: StaticSiteContext): DataHolder
def yamlParser(using ctx: StaticSiteContext): Parser

Concrete fields

final val ConfigSeparator: "---"
final val LineSeparator: "\n"