org.jdrupes.mdoclet.processors

Class FlexmarkProcessor

java.lang.Object

org.jdrupes.mdoclet.processors.FlexmarkProcessor

All Implemented Interfaces:

OptionChecker, MarkdownProcessor

public class FlexmarkProcessor
extends Object
implements MarkdownProcessor

This class provides an adapter for the flexmark-java Markdown processor.

The adapter supports the following flags:

-parser-profile

Sets one of the profiles defined in com.vladsch.flexmark.parser.ParserEmulationProfile. The name of the profle is the lower case name of the enum value. At the time of this writing supported names are:

• commonmark (default)
• fixed_indent
• kramdown
• markdown
• github_doc
• multi_markdown
• pegdown

-clear-extensions

Clears the list of extensions. The following extensions are predefined:

• Abbreviation
• Definition (Definition Lists)¹
• Footnote
• Tables

-extension <name>

Adds the flexmark extension with the given name to the list of extensions. If the name contains a dot, it is assumed to be a fully qualified class name. Else, it is expanded using the naming pattern used by flexmark.

The parser also supports disabling the automatic highlight feature.

1. If you use this extension, you’ll most likely want to supply a modified style sheet because the standard stylesheet assumes all definition lists to be parameter defintion lists and formats them accordingly.

   Here are the changes made for this documentation:

   /* [MOD]  */
   /* .contentContainer .description dl dd,  */ .contentContainer .details dl dt, .serializedFormContainer dl dt {
      font-size:12px;
      font-weight:bold;
      margin:10px 0 0 0;
      color:#4E4E4E;
   }
   /* [MOD] Added  */
   dl dt {
      margin:10px 0 0 0;
   }
   /* [MOD]  */
   /* .contentContainer .description dl dd,  */ .contentContainer .details dl dd, .serializedFormContainer dl dd {
   margin:5px 0 10px 0px;
   font-size:14px;
   font-family:‘DejaVu Sans Mono’,monospace;
   }
   

   ↩

Field Summary

Fields inherited from interface org.jdrupes.mdoclet.MarkdownProcessor

INTERNAL_OPT_DISABLE_AUTO_HIGHLIGHT

Constructor Summary

Constructors

Constructor and Description
FlexmarkProcessor()

Method Summary

Modifier and Type	Method and Description
int	isSupportedOption(String option)
void	start(String[][] options) Starts the processor with the given options.
String	toHtml(String markdown) Converts the given markdown test to HTML.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

FlexmarkProcessor

public FlexmarkProcessor()

Method Detail

isSupportedOption

public int isSupportedOption(String option)

Specified by:

isSupportedOption in interface OptionChecker

start

public void start(String[][] options)

Description copied from interface: MarkdownProcessor

Starts the processor with the given options.

All processors should support the special option _disable-auto-highlight_. The doclet maps its option -disable-auto-highlight to this special processor option because disabling the auto highlight feature is usually implemented by configuring the processors HTML renderer in some way.

Specified by:

start in interface MarkdownProcessor

Parameters:

options - an array of options; each entry consists of an array that has the option name as first entry and any parameters for that option as subsequent entries

toHtml

public String toHtml(String markdown)

Description copied from interface: MarkdownProcessor

Converts the given markdown test to HTML.

Specified by:

toHtml in interface MarkdownProcessor

Parameters:

markdown - the markdoen text

Returns:

the HTML