Class

org.fusesource.scalamd

MarkdownText

Related Doc: package scalamd

Permalink

class MarkdownText extends AnyRef

We collect all processing logic within this class.

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

Instance Constructors

  1. new MarkdownText(source: CharSequence)

    Permalink

Type Members

  1. case class LinkDefinition(url: String, title: String) extends Product with Serializable

    Permalink

    Link Definitions

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  5. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  6. def doAmpSpans(text: StringEx): StringEx

    Permalink

    Wrap ampersands with `.

    Wrap ampersands with `.

    Attributes
    protected
  7. def doAutoLinks(text: StringEx): StringEx

    Permalink

    Process autolinks.

    Process autolinks.

    Attributes
    protected
  8. def doBlockQuotes(text: StringEx): StringEx

    Permalink

    Process blockquotes.

    Process blockquotes.

    It is possible to have some nested block elements inside blockquotes, so the contents is passed to runBlockGamut after some minor transformations.

    Attributes
    protected
  9. def doCodeBlocks(text: StringEx): StringEx

    Permalink

    Process code blocks.

    Process code blocks.

    Attributes
    protected
  10. def doCodeSpans(protector: Protector, text: StringEx): StringEx

    Permalink

    Process code spans.

    Process code spans.

    Attributes
    protected
  11. def doEmphasis(text: StringEx): StringEx

    Permalink

    Process EMs and STRONGs.

    Process EMs and STRONGs.

    Attributes
    protected
  12. def doHeaders(text: StringEx): StringEx

    Permalink

    Process both types of headers.

    Process both types of headers.

    Attributes
    protected
  13. def doHorizontalRulers(text: StringEx): StringEx

    Permalink

    Process horizontal rulers.

    Process horizontal rulers.

    Attributes
    protected
  14. def doImages(text: StringEx): StringEx

    Permalink

    Process images.

    Process images.

    Attributes
    protected
  15. def doInlineLinks(text: StringEx): StringEx

    Permalink

    Process inline links.

    Process inline links.

    Attributes
    protected
  16. def doLineBreaks(text: StringEx): StringEx

    Permalink

    Process manual linebreaks.

    Process manual linebreaks.

    Attributes
    protected
  17. def doLists(text: StringEx): StringEx

    Permalink

    Process ordered and unordered lists and list items..

    Process ordered and unordered lists and list items..

    It is possible to have some nested block elements inside lists, so the contents is passed to runBlockGamut after some minor transformations.

    Attributes
    protected
  18. def doMacros(text: StringEx): StringEx

    Permalink

    Process user-defined macros.

    Process user-defined macros.

    Attributes
    protected
  19. def doRefLinks(text: StringEx): StringEx

    Permalink

    Process reference-style links.

    Process reference-style links.

    Attributes
    protected
  20. def doSmartyPants(text: StringEx): StringEx

    Permalink

    Process SmartyPants stuff.

    Process SmartyPants stuff.

    Attributes
    protected
  21. def doToc(text: StringEx): StringEx

    Permalink

    Process user-defined macros.

    Process user-defined macros.

    Attributes
    protected
  22. def encodeAmpsAndLts(text: StringEx): StringEx

    Permalink

    Ampersands and less-than signes are encoded to & and < respectively.

    Ampersands and less-than signes are encoded to & and < respectively.

    Attributes
    protected
  23. def encodeBackslashEscapes(text: StringEx): StringEx

    Permalink

    All characters escaped with backslash are encoded to corresponding SGML entities.

    All characters escaped with backslash are encoded to corresponding SGML entities.

    Attributes
    protected
  24. def encodeCharsInsideTags(text: StringEx): StringEx

    Permalink

    Encodes specially-treated characters inside the HTML tags.

    Encodes specially-treated characters inside the HTML tags.

    Attributes
    protected
  25. def encodeCode(code: StringEx): StringEx

    Permalink

    All unsafe chars are encoded to SGML entities inside code blocks.

    All unsafe chars are encoded to SGML entities inside code blocks.

    Attributes
    protected
  26. def encodeEmail(s: String): String

    Permalink

    Process autoemails in anti-bot manner.

    Process autoemails in anti-bot manner.

    Attributes
    protected
  27. def encodeUnsafeChars(code: StringEx): StringEx

    Permalink

    All unsafe chars are encoded to SGML entities.

    All unsafe chars are encoded to SGML entities.

    Attributes
    protected
  28. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  29. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  30. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  31. def formParagraphs(text: StringEx): StringEx

    Permalink

    At this point all HTML blocks should be hashified, so we treat all lines separated by more than 2 linebreaks as paragraphs.

    At this point all HTML blocks should be hashified, so we treat all lines separated by more than 2 linebreaks as paragraphs.

    Attributes
    protected
  32. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  33. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  34. def hashHtmlBlocks(text: StringEx): StringEx

    Permalink

    All inline HTML blocks are hashified, so that no harm is done to their internals.

    All inline HTML blocks are hashified, so that no harm is done to their internals.

    Attributes
    protected
  35. def hashHtmlComments(text: StringEx): StringEx

    Permalink

    All HTML comments are hashified too.

    All HTML comments are hashified too.

    Attributes
    protected
  36. val htmlProtector: Protector

    Permalink
  37. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  38. var links: Map[String, LinkDefinition]

    Permalink
    Attributes
    protected
  39. var listLevel: Int

    Permalink
    Attributes
    protected
  40. var macros: List[MacroDefinition]

    Permalink
    Attributes
    protected
  41. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  42. def normalize(text: StringEx): qual$4.type forSome {val qual$4: qual$3.type, val qual$3: normalize.text.type}

    Permalink

    Normalization includes following stuff:

    Normalization includes following stuff:

    * replace DOS- and Mac-specific line endings with \n; * replace tabs with spaces; * reduce all blank lines (i.e. lines containing only spaces) to empty strings.

    Attributes
    protected
  43. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  44. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  45. def processListItems(text: StringEx): StringEx

    Permalink
    Attributes
    protected
  46. def protectCodeSpans(protector: Protector, text: StringEx): StringEx

    Permalink
    Attributes
    protected
  47. def protectHtmlTags(protector: Protector, text: StringEx): StringEx

    Permalink
    Attributes
    protected
  48. def runBlockGamut(text: StringEx): StringEx

    Permalink

    Block elements are processed within specified text.

    Block elements are processed within specified text.

    Attributes
    protected
  49. def runSpanGamut(text: StringEx): StringEx

    Permalink

    Span elements are processed within specified text.

    Span elements are processed within specified text.

    Attributes
    protected
  50. def stripLinkDefinitions(text: StringEx): StringEx

    Permalink

    Standalone link definitions are added to the dictionary and then stripped from the document.

    Standalone link definitions are added to the dictionary and then stripped from the document.

    Attributes
    protected
  51. def stripMacroDefinitions(text: StringEx): StringEx

    Permalink

    Macro definitions are stripped from the document.

    Macro definitions are stripped from the document.

    Attributes
    protected
  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  53. var text: StringEx

    Permalink
    Attributes
    protected
  54. def toHtml(): String

    Permalink

    Transform the Markdown source into HTML.

  55. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  56. def to_id(label: String): String

    Permalink
  57. def unprotect(protector: Protector, text: StringEx): StringEx

    Permalink
    Attributes
    protected
  58. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  59. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  60. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from AnyRef

Inherited from Any

Ungrouped