Markdown markup

This article explains the supported Markdown markup. See docsify.js.org for more information. To have a general view of Markdown markup, see for example: markdownguide.org/basic-syntax.

Starting elements

Article title

The title of the article will use the name of the file without the "md" extension. For example, the following file: myfile.md will create an article with the name MyFile.

If the first element in the article is a title of level 1 (for example "# Guide"), this title will be used for the article name instead.

Index article

The README.md article is the index article.

Syntax elements

code

A code will be added by enclosing the code text by "`" characters.

Example

      the line with `code`

pre

A pre without syntax highlighting will be added by putting a space before the text on the lines.

Another way to add a pre is by enclosing the pre lines by "```" characters. For example:

      ```
      the pre text
      ```      

It is possible to specify the syntax highlighting by adding the syntax after the "```" characters. For example:

      ```json
      {id: "theID"}
      ```      

blockquote

A blockquote will be added by beginning a line with "> ". Note that you can have several levels of blockquotes.

Example

      > the first line
      > the second line

Article references

An article reference will be added by the following construct: [<link text>](<link path>) where the path points to the referenced article source file. The path can be relative or absolute^[1]

Note that the syntax for internal wiki links and external links is the same

.

The link can also point to an XML article source.

Examples

      [the reference text](api-world.md)
      [internal ref](api-world.md#the title)
      [internal ref in the same file](#the title)

External links

External links are added by the following construct: [<link text>](<link URL>) where the URL points to an http or https site^[1]

Note that the syntax for internal wiki links and external links is the same

.

Example

      [the reference text](http://docs.oracle.com/javase/8/docs)

Titles

Titles can be defined by setting one or more "#" characters at the beginning of a line. The level of the title is specified by the number of "#" characters.

Note that if there is only one title of level 1 at the beginning of the article, this title will be used for the article title, the title will not be used in the article, and all the titles below will have one level less.

Example

      ##my title

lists

Unordered list items can be defined by putting a "*" at the beginning of a line. Ordered list items can be defined by putting a number followed by a fot at the beginning of a line.

Examples

      * first unordered item
      * second unordered item  

      1. first ordered item
      2. second ordered item

Images

An image will be added by one of the following constructs:

• ![<image caption>](<image path>) for using the original image size
• ![<image caption>](<image path> =<with>x) for setting the destination image width
• ![<image caption>](<image path> =<with>x<height>) for setting the destination image width and height

Example:

      ![the image](ball.jpg =30x)

Syntax justification elements

br

A break will be added by ending a line with two or more spaces.

hr

A thematic break is specified by either:

• Having 3 stars ("***") at the beginning of a line
• Having 3 minus signs "---" at the beginning of a line
• Having 3 underscores "___" at the beginning of a line

Formatting text

It is possible the style (bold or italic) of the text using one of the following tags:

• Bold is defined by encoding the text by "**"
• Italic is defined by encoding the text by "_"