scaladoc
API
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL
scaladoc/dotty.tools.scaladoc.site

dotty.tools.scaladoc.site

package dotty.tools.scaladoc.site

Members list

Concise view

Type members

Classlikes

object FlexmarkSectionWrapper

Attributes

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

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class LoadedTemplate(templateFile: TemplateFile, children: List[LoadedTemplate], file: File, hidden: Boolean)

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
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

Attributes

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

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
case class ResolvedPage(code: String, resources: List[String])

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum Sidebar

Attributes

Companion:
object
Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
object Sidebar

Attributes

Companion:
enum
Graph
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

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

Attributes

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

Attributes

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
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.

Attributes

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).

Graph
Supertypes
trait Product
trait Equals
class Object
trait Matchable
class Any
enum TemplateName(val name: String)

Attributes

Graph
Supertypes
trait Enum
trait Product
trait Equals
class Object
trait Matchable
class Any
Known subtypes

Value members

Concrete methods

def defaultMarkdownOptions(using ctx: StaticSiteContext): DataHolder
def loadTemplateFile(file: File, defaultTitle: Option[TemplateName])(using ctx: StaticSiteContext): TemplateFile
def yamlParser(using ctx: StaticSiteContext): Parser

Concrete fields

final val ConfigSeparator: "---"
final val LineSeparator: "\n"
Generated with
© 2002-2021 · LAMP/EPFL
© 2002-2021 · LAMP/EPFL