scaladoc
DocsAPI
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL
scaladoc/dotty.tools/dotty.tools.scaladoc/dotty.tools.scaladoc.site

dotty.tools.scaladoc.site

package dotty.tools.scaladoc.site

Members list

Type members

Experimental classlikes

case class BlogConfig(input: String, output: String, hidden: Boolean)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object BlogParser

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Self type
BlogParser.type
object FlexmarkSectionWrapper

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
Self type
case class LazyEntry(getKey: String, value: () => String) extends Entry[String, Object]

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
trait Entry[String, Object]
class Object
trait Matchable
class Any
Show all
case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File, hidden: Boolean)

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class RenderingContext(properties: Map[String, Object], layouts: Map[String, TemplateFile], resolving: Set[String], resources: List[String])

RenderingContext stores information about defined properties, layouts and sites being resolved

RenderingContext stores information about defined properties, layouts and sites being resolved

Value parameters

layouts

Map containing defined site layouts

properties

Map containing defined properties

resolving

Set containing names of sites being resolved in this context. This information is useful for cycle detection

resources

List of resources that need to be appended to sites

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ResolvedPage(code: String, resources: List[String])

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum Sidebar

Attributes

Companion
object
Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object Sidebar

Attributes

Companion
enum
Experimental
true
Supertypes
trait Sum
trait Mirror
class Object
trait Matchable
class Any
Self type
Sidebar.type
class StaticSiteContext(val root: File, val args: Args, val sourceLinks: SourceLinks, val snippetCompilerArgs: SnippetCompilerArgs, val snippetChecker: SnippetChecker)(using val outerCtx: CompilerContext)

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
class StaticSiteLoader(val root: File, val args: Args)(using x$3: StaticSiteContext, x$4: CompilerContext)

Attributes

Experimental
true
Supertypes
class Object
trait Matchable
class Any
case class StaticSiteRoot(rootTemplate: LoadedTemplate, siteMappings: Map[Path, Path])

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
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).

Attributes

Experimental
true
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
enum TemplateName(val name: String)

Attributes

Experimental
true
Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
Known subtypes
class YamlDefined

Value members

Experimental methods

def defaultMarkdownOptions(using ctx: StaticSiteContext): DataHolder

Attributes

Experimental
true
def emptyTemplate(file: File, title: String): TemplateFile

Attributes

Experimental
true
def loadTemplateFile(file: File, defaultTitle: Option[TemplateName])(using ctx: StaticSiteContext): TemplateFile

Attributes

Experimental
true
def yamlParser(using ctx: StaticSiteContext): Parser

Attributes

Experimental
true

Experimental fields

final val ConfigSeparator: "---"

Attributes

Experimental
true
final val LineSeparator: "\n"

Attributes

Experimental
true
val apiPageDRI: DRI

Attributes

Experimental
true
val docsRootDRI: DRI

Attributes

Experimental
true
Generated with
Copyright (c) 2002-2024, LAMP/EPFL
Copyright (c) 2002-2024, LAMP/EPFL