dotty.tools.dottydoc

staticsite

package staticsite

Visibility
  1. Public
  2. All

Type Members

  1. class BlogPost extends AnyRef

    A BlogPost represents the parsed posts from ./blog/_posts/ each post must be named according to the format YYYY-MM-DD-title.{md,html}

  2. case class DefaultParams(docs: List[_], originalDocs: Map[String, Package], page: PageInfo, site: SiteInfo, sidebar: Sidebar, entity: Entity = NonEntity) extends Product with Serializable

  3. class HtmlPage extends Page

  4. case class IllegalFrontMatter(message: String) extends Exception with Product with Serializable

    When the YAML front matter cannot be parsed, this exception is thrown

  5. case class Include(path: String, content: SourceFile) extends Template with Product with Serializable

  6. case class Layout(path: String, content: SourceFile) extends Template with Product with Serializable

  7. case class LiquidTemplate(path: String, content: SourceFile) extends Template with ResourceFinder with Product with Serializable

  8. class MarkdownPage extends Page

  9. trait Page extends AnyRef

  10. case class PageInfo(url: String, date: String = "") extends Product with Serializable

  11. trait ResourceFinder extends AnyRef

  12. case class Sidebar(titles: List[Title]) extends Product with Serializable

  13. case class Site(root: File, projectTitle: String, documentation: Map[String, Package]) extends ResourceFinder with Product with Serializable

  14. case class SiteInfo(baseurl: String, projectTitle: String, posts: Array[BlogPost]) extends Product with Serializable

  15. trait Template extends AnyRef

  16. case class TemplateRenderingError(path: String, ex: Throwable) extends Exception with Product with Serializable

  17. case class Title(title: String, url: Option[String], subsection: List[Title]) extends Product with Serializable

Value Members

  1. object BlogPost

  2. object LiquidTemplate extends Serializable

  3. object MapOperations

    A simple wrapper for Maps to impose a certain degree of typesafety

  4. object MarkdownCodeBlockVisitor

  5. object MarkdownLinkVisitor

  6. object Sidebar extends Serializable

  7. object Site extends Serializable

  8. object Title extends Serializable

  9. object Yaml

  10. object filters

    Custom liquid template filters

  11. object tags

Ungrouped