Type Members

1.  class AnchorLinkSerializer extends ToHtmlSerializerPlugin

   Serialize an AnchorLinkSuperNode, which can contain multiple children.

   Serialize an AnchorLinkSuperNode, which can contain multiple children. Render as a separate anchor link for section markers on headers.

2.  abstract class ApiDocDirective extends ExternalLinkDirective

   API doc directive.

   API doc directive.

   Link to javadoc and scaladoc based on package prefix. Will match the configured base URL with the longest package prefix. For example, given:

   - scaladoc.akka.base_url=http://doc.akka.io/api/akka/x.y.z - scaladoc.akka.http.base_url=http://doc.akka.io/api/akka-http/x.y.z

   Then @scaladoc[Http](akka.http.scaladsl.Http) will match the latter.

3.  case class CalloutDirective (name: String, defaultTitle: String) extends ContainerBlockDirective with Product with Serializable

   Callout directive.

   Callout directive.

   Renders call-out divs.

4.  class ClassyLinkSerializer extends ToHtmlSerializerPlugin

   Serialize a ClassyLink, adding the class attribute.

5.  abstract class ContainerBlockDirective extends Directive

   Container block directive.

6.  case class DependencyDirective (variables: Map[String, String]) extends LeafBlockDirective with Product with Serializable

   Dependency directive.

7.  abstract class Directive extends AnyRef

   Base directive class, for directive specific serialization.

8.  class DirectiveSerializer extends ToHtmlSerializerPlugin

   Serialize directives, checking the name and format against registered directives.

9.  case class ExtRefDirective (page: Page, variables: Map[String, String]) extends ExternalLinkDirective with Product with Serializable

   ExtRef directive.

   ExtRef directive.

   Link to external pages using URL templates.

10.  abstract class ExternalLinkDirective extends InlineDirective with SourceDirective

    Link to external sites using URI templates.

11.  case class FiddleDirective (page: Page, variables: Map[String, String]) extends LeafBlockDirective with SourceDirective with Product with Serializable

    Fiddle directive.

    Fiddle directive.

    Extracts fiddles from source files into fiddle blocks.

12.  case class Frontin (header: Map[String, String], body: String) extends Product with Serializable
13.  case class GitHubDirective (page: Page, variables: Map[String, String]) extends ExternalLinkDirective with Product with Serializable

    GitHub directive.

    GitHub directive.

    Link to GitHub project entities like issues, commits and source code. Supports most of the references documented in: https://help.github.com/articles/autolinked-references-and-urls/

14.  case class Header (path: String, label: Node, group: Option[String]) extends Linkable with Product with Serializable

    Header in a page, with anchor path and markdown nodes.

15.  abstract class InlineDirective extends Directive

    Inline directive.

16.  case class InlineGroupDirective (groups: Seq[String]) extends InlineDirective with Product with Serializable
17.  case class InlineWrapDirective (typ: String) extends InlineDirective with Product with Serializable

    Inline wrap directive

    Inline wrap directive

    Wraps inner contents in a span, optionally with custom id and/or class attributes.

18.  case class JavadocDirective (page: Page, variables: Map[String, String]) extends ApiDocDirective with Product with Serializable
19.  abstract class LeafBlockDirective extends Directive

    Leaf block directive.

20.  sealed abstract class Linkable extends AnyRef

    Common interface for Page and Header, which are linkable.

21.  case class Page (file: File, path: String, rootSrcPage: String, label: Node, h1: Header, headers: Forest[Header], markdown: RootNode, group: Option[String], properties: Properties) extends Linkable with Product with Serializable

    Markdown page with target path, parsed markdown, and headers.

22.  case class PropertyUrl (property: String, variables: (String) ⇒ Option[String]) extends Product with Serializable
23.  class Reader extends AnyRef

    A configured markdown parser.

24.  case class RefDirective (page: Page, pathExists: (String) ⇒ Boolean, convertPath: (String) ⇒ String) extends InlineDirective with SourceDirective with Product with Serializable

    Ref directive.

    Ref directive.

    Refs are for links to internal pages. The file extension is replaced when rendering. Links are validated to ensure they point to a known page.

25.  case class ScaladocDirective (page: Page, variables: Map[String, String]) extends ApiDocDirective with Product with Serializable
26.  case class SnipDirective (page: Page, variables: Map[String, String]) extends LeafBlockDirective with SourceDirective with Product with Serializable

    Snip directive.

    Snip directive.

    Extracts snippets from source files into verbatim blocks.

27.  sealed trait SourceDirective extends AnyRef

    Directives with defined "source" semantics.

28.  abstract class StyledVerbatimSerializer extends VerbatimSerializer

    Add markup around verbatim blocks.

29.  class TableOfContents extends AnyRef

    Create markdown list for table of contents on a page.

30.  case class TocDirective (location: Location[Page]) extends LeafBlockDirective with Product with Serializable

    Table of contents directive.

    Table of contents directive.

    Placeholder to insert a serialized table of contents, using the page and header trees. Depth and whether to include pages or headers can be specified in directive attributes.

31.  case class Url (base: URI) extends Product with Serializable

    Small wrapper around URI to help update individual components.

32.  case class VarDirective (variables: Map[String, String]) extends InlineDirective with Product with Serializable

    Var directive.

    Var directive.

    Looks up property values and renders escaped text.

33.  case class VarsDirective (variables: Map[String, String]) extends ContainerBlockDirective with Product with Serializable

    Vars directive.

    Vars directive.

    Replaces property values in verbatim blocks.

34.  case class WrapDirective (typ: String) extends ContainerBlockDirective with Product with Serializable

    Wrap directive.

    Wrap directive.

    Wraps inner content in a div or p, optionally with custom id and/or class attributes.

35.  class Writer extends AnyRef

    A configured markdown to HTML serializer.