Package

laika.markdown

github

Permalink

package github

Visibility
  1. Public
  2. All

Value Members

  1. object AutoLinks

    Permalink

    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.

  2. object FencedCodeBlocks

    Permalink

    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.

    This implementation differs from the spec in one aspect: a fenced code block must be preceded by a blank line. This is due to technical reasons of fenced code blocks being an extension and the default paragraph parser not knowing about the installed extensions and which of them are allowed to interrupt a paragraph. Later version might support the exact spec, but that would require changes in how parser extensions are registered and combined with the native parsers.

  3. object GitHubFlavor extends ExtensionBundle

    Permalink

    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 transformation like any other extension:

    Transform
      .from(Markdown).to(HTML)
      .using(GitHubFlavor)
      .fromFile("hello.md").toFile("hello.html")

    These are the parsers this extension adds to standard Markdown:

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

  4. object Strikethrough

    Permalink

    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-.

  5. object Tables

    Permalink

    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

Ungrouped