markdown

Type Members

1. case class AtxHeaderLine(pre: String, pay: String) extends MarkdownLine with Product with Serializable

   

   An atx style header line.

   An atx style header line. Trims hashes automatically and determines the header level from them.

2. trait BaseParsers extends RegexParsers

   

   Basic parsers for Markdown Source.

   Basic parsers for Markdown Source. Provides general, small parsers that are used by other parsers. Also contains parsers for XML elements.

3. trait BlockParsers extends Parsers

   

   A parser for the markdown language.

   A parser for the markdown language. Works on pre-parsed lines that can be created by a LineParser.

4. case class BlockQuoteLine(pre: String, pay: String) extends MarkdownLine with Product with Serializable

   

   A line indicating a block quote (starts with "> ")

5. case class CodeLine(pre: String, pay: String) extends MarkdownLine with Product with Serializable

   

   A line in verbatim code or the continuation of a list item

6. trait Decorator extends AnyRef

   

   This trait influences the behavior of the Markdown output of inline and block parsers and the complete transformer.

   This trait influences the behavior of the Markdown output of inline and block parsers and the complete transformer. Mix in this trait and override methods to change the behavior and override the "deco()" method in the respective parser/transformer to return your modified instances to change the output they create.

   Inline element decoration methods always get passed the spanned text, so you have to prepend and append the opening/closing tags. For block elements there is always a method for the opening and closing tags. This is to make block processing more efficient to prevent unnecessary String building of whole blocks just to add tags. (The block building uses a StringBuilder internally and just appends the returned tags)

   If you want line breaks after opening/closing block level tags, you have to add the newline yourself.

7. case class EmptyLine(content: String) extends MarkdownLine with Product with Serializable

   

   A line consisting only of whitespace.

8. case class ExtendedFencedCode(pre: String, pay: String) extends MarkdownLine with Product with Serializable

   

   Starting line of a fenced code block: three backticks followed by an optional language token

9. case class FencedCode(pre: String) extends MarkdownLine with Product with Serializable

   

   Ending line of a fenced code block: three backticks followed by optional whitespace

10. trait InlineParsers extends BaseParsers

    

    A parser for inline markdown, markdown escapes and XML escapes.

    A parser for inline markdown, markdown escapes and XML escapes. This is used by the result classes of the block parsers to handle Markdown within a block.

11. trait LineParsers extends InlineParsers

    

    Parses single lines into tokens.

    Parses single lines into tokens. Markdown lines are differentiated by their beginning. These lines are then organized in blocks by the BlockParsers.

12. case class LineReader extends Reader[String] with Product with Serializable

    

    A Reader for reading whole Strings as tokens.

    A Reader for reading whole Strings as tokens. Used by the Tokenizer to parse whole lines as one Element.

13. class LineTokenizer extends Parsers

    

    Chops the input into lines and turns those lines into line tokens.

    Chops the input into lines and turns those lines into line tokens. Also takes care of preprocessing link definitions and xml blocks.

14. case class LinkDefinition(id: String, url: String, title: Option[String]) extends Product with Serializable

    

    Definition of a link or url that can be referenced by id.

15. case class LinkDefinitionStart(id: String, url: String) extends Product with Serializable

    

    Stub class that is an intermediate result when parsing link definitions.

16. sealed abstract class MarkdownLine extends AnyRef

    

    Represents a line of markdown.

    Represents a line of markdown. The prefix is the beginning of the line that indicates the line type, the payload is the actual content after the prefix.

17. case class MarkdownLineReader extends Reader[MarkdownLine] with Product with Serializable

    

    This class allows us to reference a map with link definitions resulting from the line parsing during block parsing.

    This class allows us to reference a map with link definitions resulting from the line parsing during block parsing. It extends a Reader for MarkdownLines and allows us to add the said map to the parsing context. This is basically a modification of the parser monad's state.

18. case class OItemStartLine(pre: String, pay: String) extends MarkdownLine with Product with Serializable

    

    A line indicating the start of an ordered list item (starts with " [NUMBER].

    A line indicating the start of an ordered list item (starts with " [NUMBER]. ")

19. case class OtherLine(content: String) extends MarkdownLine with Product with Serializable

    

    Any other line.

20. case class RulerLine(content: String) extends MarkdownLine with Product with Serializable

    

    A horizontal ruler line.

21. case class SetExtHeaderLine(content: String, headerLevel: Int) extends MarkdownLine with Product with Serializable

    

    Represents the underline for a setext style header

22. class SingleThreadedTransformer extends Transformer

    

23. class ThreadLocalTransformer extends Transformer

    

    Simple Standalone Markdown transformer.

    Simple Standalone Markdown transformer. Use this if you simply want to transform a block of markdown without any special options. val input:String = ... val xhtml:String = new ActuariusTransformer()(input)

    Note that this markdown parser isn't inherently thread-safe, as Scala Parser Combinators aren't, so this class instantiates a SingleThreadedTransformer for each thread. You'll need to write your own pooled implementation if this isn't efficient for your usage.

24. trait TimedTransformer extends AnyRef

    

    Quick and dirty test for measuring the time of this Parser.

    Quick and dirty test for measuring the time of this Parser. Contains hardcoded file paths, just ignore this, it will be removed soon.

25. trait Transformer extends AnyRef

    

    This is the Transformer that uses the other parsers to transform markdown into xhtml.

    This is the Transformer that uses the other parsers to transform markdown into xhtml. Mix this trait in if you want more control over the output (like switching verbatim xml on/off or using different opening/closing tags for the output).

26. case class UItemStartLine(pre: String, pay: String) extends MarkdownLine with Product with Serializable

    

    A line indicating the start of an unordered list item (starts with " * ")

27. case class XmlChunk(content: String) extends MarkdownLine with Product with Serializable

    

    Represents lines of verbatim xml.

    Represents lines of verbatim xml. Actually this class is a little cheat, as it represents multiple lines. But it is a token that is created when "parsing with a line scope", so it is not too bad.