Packages

c

com.lightbend.paradox

ParadoxProcessor

class ParadoxProcessor extends AnyRef

Markdown site processor.

Linear Supertypes
AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ParadoxProcessor
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ParadoxProcessor(reader: Reader = new Reader, writer: Writer = new Writer)

Type Members

  1. case class GithubLink (location: Option[Location[Page]], page: Page, writer: Writer, context: Context) extends Link with Product with Serializable

    Github links, rendered to just a HTML for the link.

  2. case class PageContents (leadingBreadcrumbs: List[(String, String)], groups: Map[String, Seq[String]], loc: Location[Page], writer: Writer, context: Context, navToc: TableOfContents, pageToc: TableOfContents) extends Contents with Product with Serializable

    Default template contents for a markdown page at a particular location.

  3. case class PageLink (location: Option[Location[Page]], current: Page, writer: Writer, context: Context) extends Link with Product with Serializable

    Default template links, rendered to just a relative uri and HTML for the link.

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  5. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  7. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  8. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  9. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
  10. def hashCode(): Int
    Definition Classes
    AnyRef → Any
  11. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  12. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  13. def normalizePath(path: String, separator: Char = java.io.File.separatorChar): String

    Normalize path to '/' separator.

  14. final def notify(): Unit
    Definition Classes
    AnyRef
  15. final def notifyAll(): Unit
    Definition Classes
    AnyRef
  16. def parseMarkdown(mappings: Seq[(File, String)]): Seq[(File, String, RootNode, Map[String, String])]

    Parse markdown files into pegdown AST.

  17. def parsePages(mappings: Seq[(File, String)], convertPath: (String) ⇒ String): Forest[Page]

    Parse markdown files (with paths) into a forest of linked pages.

  18. def process(mappings: Seq[(File, String)], leadingBreadcrumbs: List[(String, String)], outputDirectory: File, sourceSuffix: String, targetSuffix: String, groups: Map[String, Seq[String]], properties: Map[String, String], navDepth: Int, navExpandDepth: Option[Int], navIncludeHeaders: Boolean, pageTemplate: PageTemplate, errorListener: STErrorListener): Seq[(File, String)]

    Process all mappings to build the site.

  19. def rootPageMappings(pages: Forest[Page]): Map[String, String]

    Create Mappings from page path to target file name

  20. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  21. def toString(): String
    Definition Classes
    AnyRef → Any
  22. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  23. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  24. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped