markdown
API
Generated with
markdown/io.github.edadma.markdown

io.github.edadma.markdown

package io.github.edadma.markdown

Members list

Type members

Classlikes

object ATXHeadingBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class AutoLink(destination: String, text: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
trait Block extends Node

Attributes

Supertypes
trait Node
class Object
trait Matchable
class Any
Known subtypes
class BlockQuote
class CalloutBlock
class Code
class HTMLBlock
class Heading
class ListBlock
class ListItem
class MathBlock
class Paragraph
class Table
class TableCell
class TableRow
Show all
trait BlockParser

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
Show all
case class BlockQuote(children: List[Block]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object BlockQuoteParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class C(char: Char, pos: Int, line: Int, column: Int, isLiteral: Boolean) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
Known subtypes
object EndOfInput
case class CalloutBlock(calloutType: String, title: Option[String], children: List[Block]) extends Block

Represents a callout block in the document.

Represents a callout block in the document.

A callout block is a specialized form of block quote with additional metadata for type and optional title to create visually distinct "callout" sections.

Value parameters

calloutType

The type of callout (e.g., "note", "warning", "info", "tip", "danger")

children

Child blocks within the callout

title

Optional title for the callout block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object CalloutBlockParser extends BlockParser

Parser for callout blocks in Markdown.

Parser for callout blocks in Markdown.

Implements the syntax: > [!TYPE] or > [!TYPE]: Title where TYPE is the callout type (e.g., note, warning, info)

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class Code(content: String, infoString: Option[String]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
case class CodeSpan(content: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class CollapsibleBlock(title: String, isOpen: Boolean, children: List[Block]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object CollapsibleBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class DefinitionListBlock(items: List[(List[Inline], List[Block])]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object DefinitionListBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class DelimiterInfo(node: DLListNode[Inline], delimiterChar: Char, length: Int, var isActive: Boolean, canOpen: Boolean, canClose: Boolean)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Document(children: List[Block]) extends Node

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Node
class Object
trait Matchable
class Any
Show all
case class Emoji(name: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
enum EmojiConfig

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class Emphasis(inlines: List[Inline]) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
object EndOfInput extends C

Attributes

Supertypes
class C
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
Self type
EndOfInput.type
object FencedCodeBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class HTMLBlock(content: String) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object HTMLBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class HardLineBreak() extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class Heading(level: Int, inlines: List[Inline]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
case class Image(destination: String, title: Option[String], inlines: List[Inline]) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
object IndentedCodeBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
sealed trait Inline extends Node

Attributes

Supertypes
trait Node
class Object
trait Matchable
class Any
Known subtypes
class AutoLink
class C
object EndOfInput
class CodeSpan
class Emoji
class Emphasis
class Image
class Link
class MathExpr
class RawHTML
class Strong
class Text
Show all
class InputReader(input: String)

Attributes

Supertypes
class Object
trait Matchable
class Any
case class Link(destination: String, title: Option[String], inlines: List[Inline]) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class LinkReference(destination: String, title: Option[String])

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object LinkReferenceDefinitionParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class ListBlock(data: ListData, items: List[ListItem]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object ListBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class ListData(isOrdered: Boolean, bulletChar: Option[Char], startNumber: Option[Int], delimiter: Option[Char], isTight: Boolean, indent: Int)

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
case class ListItem(content: List[Block]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
case class MarkdownConfig(definitionLists: Boolean, tables: Boolean, math: Boolean, emoji: EmojiConfig, callouts: Boolean)

Configuration for the Markdown processor

Configuration for the Markdown processor

Attributes

Companion
object
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object MarkdownConfig

Attributes

Companion
class
Supertypes
trait Product
trait Mirror
class Object
trait Matchable
class Any
Self type
case class MathBlock(content: String) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object MathBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class MathExpr(content: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
trait Node

Attributes

Supertypes
class Object
trait Matchable
class Any
Known subtypes
trait Block
class BlockQuote
class CalloutBlock
class Code
class HTMLBlock
class Heading
class ListBlock
class ListItem
class MathBlock
class Paragraph
class Table
class TableCell
class TableRow
class Document
trait Inline
class AutoLink
class C
object EndOfInput
class CodeSpan
class Emoji
class Emphasis
class Image
class Link
class MathExpr
class RawHTML
class Strong
class Text
Show all
case class Paragraph(inlines: List[Inline]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object ParagraphBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class RawHTML(content: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
object SetextHeadingBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class SoftLineBreak() extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class Strong(inlines: List[Inline]) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class Table(headerRow: TableRow, rows: List[TableRow], alignments: List[TableAlignment]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
enum TableAlignment

Attributes

Supertypes
trait Enum
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all
object TableBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
case class TableCell(content: List[Inline]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
case class TableRow(cells: List[TableCell]) extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
case class Text(content: String) extends Inline

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Inline
trait Node
class Object
trait Matchable
class Any
Show all
case class ThematicBreak() extends Block

Attributes

Supertypes
trait Serializable
trait Product
trait Equals
trait Block
trait Node
class Object
trait Matchable
class Any
Show all
object ThematicBreakBlockParser extends BlockParser

Attributes

Supertypes
trait BlockParser
class Object
trait Matchable
class Any
Self type
final class generateSpecTests

Attributes

Supertypes
class Object
trait Matchable
class Any

Value members

Concrete methods

def analyzeDelimiter(node: DLListNode[Inline]): DelimiterInfo
def escapeXml(s: String): String
def extractAndProcessCodeSpanContent(start: DLListNode[Inline], end: DLListNode[Inline]): String
def extractHeaders(document: Document): List[(Int, String)]
def extractInlinesBetween(start: DLListNode[Inline], end: DLListNode[Inline]): List[Inline]
def generateSpecTests(args: String*): Unit

A simple command-line utility to generate ScalaTest suites from CommonMark spec JSON test cases.

A simple command-line utility to generate ScalaTest suites from CommonMark spec JSON test cases.

Usage: sbt "runMain io.github.edadma.markdown.SpecTestGenerator spec.json > SpecTests.scala"

Attributes

def getCharFromNode(node: DLListNode[Inline]): Char
def inlinesToPlainText(inlines: List[Inline]): String
def isAbsoluteUri(str: String): Boolean
def isEmailAddress(str: String): Boolean
def isHtmlTag(str: String): Boolean
def isUnicodePunctuation(c: Char): Boolean
def isUnicodeWhitespace(c: Char): Boolean
def lookForLinkOrImage(current: DLListNode[Inline], inlineNodes: DLList[Inline], delimiterStack: Stack[DelimiterInfo], linkRefs: Map[String, LinkReference], config: MarkdownConfig): DLListNode[Inline]
def parseDocument(stream: LazyList[C], config: MarkdownConfig): (Document, Map[String, LinkReference])
def parseDocumentContent(input: String, config: MarkdownConfig): Document
def parseDocumentContentWithRefs(input: String, config: MarkdownConfig): (Document, Map[String, LinkReference])
def parseInline(inlines: List[Inline], linkRefs: Map[String, LinkReference], config: MarkdownConfig): List[Inline]
def processCodeSpan(node: DLListNode[Inline]): DLListNode[Inline]
def processEmphasis(delimiterStack: Stack[DelimiterInfo]): Unit
def processLineBreak(node: DLListNode[Inline]): DLListNode[Inline]
def renderToHTML(md: String, config: MarkdownConfig): String
def renderToHTML(node: Node): String
def renderToXML(doc: Document, system: String): String

Concrete fields

val HTMLEntities: Map[String, String]
val blockParsers: ArrayBuffer[BlockParser]
val emojiBlock1: List[(String, String)]
val emojiBlock10: List[(String, String)]
val emojiBlock11: List[(String, String)]
val emojiBlock12: List[(String, String)]
val emojiBlock13: List[(String, String)]
val emojiBlock14: List[(String, String)]
val emojiBlock15: List[(String, String)]
val emojiBlock16: List[(String, String)]
val emojiBlock17: List[(String, String)]
val emojiBlock18: List[(String, String)]
val emojiBlock19: List[(String, String)]
val emojiBlock2: List[(String, String)]
val emojiBlock3: List[(String, String)]
val emojiBlock4: List[(String, String)]
val emojiBlock5: List[(String, String)]
val emojiBlock6: List[(String, String)]
val emojiBlock7: List[(String, String)]
val emojiBlock8: List[(String, String)]
val emojiBlock9: List[(String, String)]
val emojis: Map[String, String]
val logger: Logger
Generated with