Markdown syntax

This article explains the Markdown syntax which is supported by the tool.

Configure the tool to parse articles with the Markdown syntax

To be able to parse files with the Markdown syntax, you need to set either:^[1]

You can't use both the Markdown syntax and the Mediawiki syntax

• The allowMarkdown property on the command-line
• Or the allowMarkdown configuration property

The files must have the .md extension.

For example:

      java -jar docGenerator.jar -input=wiki/input -output=wiki/output -allowMarkdown=true

Generalities

The Mardown syntax is a lightweight markup language which allows to convert the syntax to HTML files.

The markup is not clearly specified but is defined in the following website by Daring Fireball who invented this markup: daringfireball.net/projects/markdown.

The markup is not designed for interrelationships between articles, but several types of markups have been defined to allow for a wiki-style structure. The current Markdown format for docJGenerator uses the following: docsify.js.org.

Syntax

See Markdown markup.