Home Reference Source Test Repository

Typedef

Static Public Summary
public

Commad line options.
public

convert the HTML element to Markdown.
public

Optional settings of this tool.

Static Public

public CLIOptions: Object source

Commad line options.

Properties:

NameTypeAttributeDescription
help Boolean

Mode to display the help text.
version Boolean

Mode to display the version number.
input String

Path of the SVG file or PNG file directory.
output String

Path of the output directory.
noGFM Boolean

Disable a GitHub Flavored Markdown. Default is enable.
noMELink Boolean

Disable a GitHub Extra link on header. Default is enable.
report Boolean

Display the process reports. Default is disable.

public MdConverter: Object source

convert the HTML element to Markdown.

Properties:

NameTypeAttributeDescription
filter String | Array | Function

Filter to check the HTML tags.
replacement Function

Function to replace the DOM Node.

public Option: Object source

Optional settings of this tool.

Properties:

NameTypeAttributeDescription
gmf Boolean

Enable a GitHub Flavored Markdown. Default is disable.
converters Converter

Extended converter collection.