Interface PegdownExtensions

  • All Known Subinterfaces:
    Extensions

    public interface PegdownExtensions
    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int ABBREVIATIONS
      PHP Markdown Extra style abbreviations.
      static int ALL  
      static int ALL_OPTIONALS
      All Optionals other than Suppress and FORCELISTITEMPARA which is a backwards compatibility extension
      static int ALL_WITH_OPTIONALS  
      static int ANCHORLINKS
      Enables anchor links in headers.
      static int ATXHEADERSPACE
      Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header.
      static int AUTOLINKS
      Enables plain autolinks the way github flavoured markdown implements them.
      static int DEFINITIONS
      PHP Markdown Extra style definition lists.
      static int EXTANCHORLINKS
      Generate anchor links for headers using complete contents of the header.
      static int EXTANCHORLINKS_WRAP
      EXTANCHORLINKS should wrap header content instead of creating an empty anchor: `<h1><a name="header-a">header a</a></h1>`
      static int FENCED_CODE_BLOCKS
      PHP Markdown Extra style fenced code blocks.
      static int FOOTNOTES
      Enables footnote processing [^1]: Text Paragraph with continuations and footnote reference [^1]
      static int FORCELISTITEMPARA
      Force List and Definition Paragraph wrapping if it includes more than just a single paragraph
      static int GITHUB_COMMENT_COMPATIBLE
      These are GitHub comment (issues, pull requests and comments) processing compatibility flags
      static int GITHUB_DOCUMENT_COMPATIBLE
      These are GitHub main repo document processing compatibility flags
      static int GITHUB_WIKI_COMPATIBLE
      These are GitHub wiki page processing compatibility flags
      static int HARDWRAPS
      Enables the parsing of hard wraps as HTML linebreaks.
      static int INSERTED
      Enables adding a dummy reference key node to RefLink and RefImage so that the AST differs between [ ][] and plain [ ] for refLink and ![ ][] and plain ![ ] for RefImage
      static int MULTI_LINE_IMAGE_URLS
      ![alt](.....?
      static int NONE
      The default, standard markup mode without any extensions.
      static int NOT_USED
      spare bits
      static int QUOTES
      Pretty single and double quotes.
      static int RELAXEDHRULES
      Allow horizontal rules without a blank line following them.
      static int SMARTS
      Pretty ellipses, dashes and apostrophes.
      static int SMARTYPANTS
      All of the smartypants prettyfications.
      static int STRIKETHROUGH
      Support ~~strikethroughs~~ as supported in Pandoc and Github.
      static int SUBSCRIPT
      Force List and Definition Paragraph wrapping if it includes more than just a single paragraph
      static int SUPERSCRIPT
      trace parsing elements to console
      static int SUPPRESS_ALL_HTML
      Suppresses HTML blocks as well as inline HTML tags.
      static int SUPPRESS_HTML_BLOCKS
      Suppresses HTML blocks.
      static int SUPPRESS_INLINE_HTML
      Suppresses inline HTML tags.
      static int TABLES
      Table support similar to what Multimarkdown offers.
      static int TASKLISTITEMS
      GitHub style task list items: - [ ] and - [x]
      static int TOC
      Enables TOC extension
      static int UNUSABLE  
      static int UNUSED_ALL
      All available extensions excluding the high word options
      static int WIKILINKS
      Support [[Wiki-style links]].
    • Field Detail

      • NONE

        static final int NONE
        The default, standard markup mode without any extensions.
        See Also:
        Constant Field Values
      • SMARTS

        static final int SMARTS
        Pretty ellipses, dashes and apostrophes.
        See Also:
        Constant Field Values
      • AUTOLINKS

        static final int AUTOLINKS
        Enables plain autolinks the way github flavoured markdown implements them. With this extension enabled pegdown will intelligently recognize URLs and email addresses without any further delimiters and mark them as the respective link type.
        See Also:
        Github-flavored-Markdown, Constant Field Values
      • STRIKETHROUGH

        static final int STRIKETHROUGH
        Support ~~strikethroughs~~ as supported in Pandoc and Github.
        See Also:
        Constant Field Values
      • ANCHORLINKS

        static final int ANCHORLINKS
        Enables anchor links in headers.
        See Also:
        Constant Field Values
      • UNUSED_ALL

        static final int UNUSED_ALL
        All available extensions excluding the high word options
        See Also:
        Constant Field Values
      • SUPPRESS_HTML_BLOCKS

        static final int SUPPRESS_HTML_BLOCKS
        Suppresses HTML blocks. They will be accepted in the input but not be contained in the output.
        See Also:
        Constant Field Values
      • SUPPRESS_INLINE_HTML

        static final int SUPPRESS_INLINE_HTML
        Suppresses inline HTML tags. They will be accepted in the input but not be contained in the output.
        See Also:
        Constant Field Values
      • SUPPRESS_ALL_HTML

        static final int SUPPRESS_ALL_HTML
        Suppresses HTML blocks as well as inline HTML tags. Both will be accepted in the input but not be contained in the output.
        See Also:
        Constant Field Values
      • ATXHEADERSPACE

        static final int ATXHEADERSPACE
        Requires a space char after Atx # header prefixes, so that #dasdsdaf is not a header.
        See Also:
        Constant Field Values
      • SUBSCRIPT

        static final int SUBSCRIPT
        Force List and Definition Paragraph wrapping if it includes more than just a single paragraph
        See Also:
        Constant Field Values
      • RELAXEDHRULES

        static final int RELAXEDHRULES
        Allow horizontal rules without a blank line following them.
        See Also:
        Constant Field Values
      • TASKLISTITEMS

        static final int TASKLISTITEMS
        GitHub style task list items: - [ ] and - [x]
        See Also:
        Constant Field Values
      • EXTANCHORLINKS

        static final int EXTANCHORLINKS
        Generate anchor links for headers using complete contents of the header. Spaces and non-alphanumerics replaced by `-`, multiple dashes trimmed to one. Anchor link is added as first element inside the header with empty content: `<h1><a name="header-a"></a>header a</h1>`
        See Also:
        Constant Field Values
      • EXTANCHORLINKS_WRAP

        static final int EXTANCHORLINKS_WRAP
        EXTANCHORLINKS should wrap header content instead of creating an empty anchor: `<h1><a name="header-a">header a</a></h1>`
        See Also:
        Constant Field Values
      • FOOTNOTES

        static final int FOOTNOTES
        Enables footnote processing [^1]: Text Paragraph with continuations and footnote reference [^1]
        See Also:
        Constant Field Values
      • MULTI_LINE_IMAGE_URLS

        static final int MULTI_LINE_IMAGE_URLS
        ![alt](.....?

        )

        ![alt](.....?

        "title")

        Enables MULTI_LINE_IMAGE_URLS extension which allows image urls of the form above. any text at all until ) or "title") at the begining of a line. Used for displaying UML diagrams with gravizo.com

        See Also:
        Constant Field Values
      • SUPERSCRIPT

        static final int SUPERSCRIPT
        trace parsing elements to console
        See Also:
        Constant Field Values
      • FORCELISTITEMPARA

        static final int FORCELISTITEMPARA
        Force List and Definition Paragraph wrapping if it includes more than just a single paragraph
        See Also:
        Constant Field Values
      • INSERTED

        static final int INSERTED
        Enables adding a dummy reference key node to RefLink and RefImage so that the AST differs between [ ][] and plain [ ] for refLink and ![ ][] and plain ![ ] for RefImage
        See Also:
        Constant Field Values
      • ALL_OPTIONALS

        static final int ALL_OPTIONALS
        All Optionals other than Suppress and FORCELISTITEMPARA which is a backwards compatibility extension
        See Also:
        Constant Field Values
      • GITHUB_DOCUMENT_COMPATIBLE

        static final int GITHUB_DOCUMENT_COMPATIBLE
        These are GitHub main repo document processing compatibility flags
        See Also:
        Constant Field Values
      • GITHUB_WIKI_COMPATIBLE

        static final int GITHUB_WIKI_COMPATIBLE
        These are GitHub wiki page processing compatibility flags
        See Also:
        Constant Field Values
      • GITHUB_COMMENT_COMPATIBLE

        static final int GITHUB_COMMENT_COMPATIBLE
        These are GitHub comment (issues, pull requests and comments) processing compatibility flags
        See Also:
        Constant Field Values