Home Reference Source Test

Typedef

Static Public Summary
public	CLIOptions: Object Commad line options.
public	MdConverter: Object convert the HTML element to Markdown.
public	Modes: Object Modes of markdown parse and output.
public	ReplaceLinkPrefix: Object Value of replace link prefix.

Static Public

public CLIOptions: Object source

Commad line options.

Properties:

Name	Type	Attribute	Description
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.
report	Boolean		Display the process reports. Default is disable.
noGFM	Boolean		Disable the GitHub Flavored Markdown.
noMELink	Boolean		Disable the Markdown Extra link on header.
withMetadata	Boolean		Enable output article metadata.
withImageLinkReplace	Boolean		Enable download and replace link syntaxes a linked images from article.
replaceLinkPrefix	ReplaceLinkPrefix		Replace the link URL prefix with the specified word.

public MdConverter: Object source

convert the HTML element to Markdown.

Properties:

Name	Type	Attribute	Description
filter	String \| Array \| Function		Filter to check the HTML tags.
replacement	Function		Function to replace the DOM Node.

public Modes: Object source

Modes of markdown parse and output.

Properties:

Name	Type	Attribute	Description
noGFM	Boolean		Disable a GitHub Flavored Markdown. Default is enable.
noMELink	Boolean		Disable a GitHub Extra link on header. Default is enable.
withMetadata	Boolean		Output article metadata in YAML format at the top of Markdown.
withImageLinkReplace	Boolean		Download the linked images from articles. The file name is the same as markdown. Multiple images become serial numbers.

public ReplaceLinkPrefix: Object source

Value of replace link prefix.

Properties:

Name	Type	Attribute	Description
old	String		Target string.
new	String		Placeholder string.