Class MarkdownProcessor


  • public class MarkdownProcessor
    extends Object
    Discover plugin documentation, process a markdown document and convert to HTML.
    • Constructor Detail

      • MarkdownProcessor

        public MarkdownProcessor()
    • Method Detail

      • processPlugin

        public boolean processPlugin​(Class plugin,
                                     URL targetFile)
        Main method to process plugin documentation.
        Parameters:
        plugin - plugin class
        targetFile - file where to save HTML
        Returns:
        true if documentation is resolved and created
      • markdownToHtml

        public String markdownToHtml​(String src)
        Convert markdown to HTML
        Parameters:
        src - markdown content
        Returns:
        html content
      • resolveMarkdownDoc

        public String resolveMarkdownDoc​(Class plugin)
        Resolve README.md file from plugin package and from main plugin directory.
        Parameters:
        plugin - plugin class
        Returns:
        the content of README.md or null (if no documentation exists)