laika.markdown.github

Members list

Type members

Classlikes

object AutoLinks

Parsers for inline auto-links, which are urls or email addresses that are recognized and inserted as links into the AST without any surrounding markup delimiters.

Parsers for inline auto-links, which are urls or email addresses that are recognized and inserted as links into the AST without any surrounding markup delimiters.

In contrast to the rather informal description of the GitHub-Flavored-Markdown spec, parsing of the http or email URIs is based on the corresponding RFCs. See laika.parse.uri.URIParsers for details.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
AutoLinks.type

Parser for fenced code blocks as defined by GitHub Flavored Markdown and CommonMark.

Parser for fenced code blocks as defined by GitHub Flavored Markdown and CommonMark.

For the spec see https://github.github.com/gfm/#fenced-code-blocks.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object GitHubFlavor extends ExtensionBundle

Extension bundle that enables GitHub-Flavored Markdown on top of standard Markdown.

Extension bundle that enables GitHub-Flavored Markdown on top of standard Markdown.

The extension can be added to a transformer like any other extension:

 val transformer = Transformer
   .from(Markdown)
   .to(HTML)
   .using(GitHubFlavor)
   .build

These are the parsers this extension adds to standard Markdown:

  • strikethrough
  • auto-links (urls and email addresses)
  • fenced code blocks
  • tables

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Strikethrough

Parser for spans with strike-through markup.

Parser for spans with strike-through markup.

For the spec see https://github.github.com/gfm/#strikethrough-extension-.

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
object Tables

Parser for the table extension of GitHub Flavored Markdown.

Parser for the table extension of GitHub Flavored Markdown.

For the spec see https://github.github.com/gfm/#table

Attributes

Supertypes
class Object
trait Matchable
class Any
Self type
Tables.type