Using the Markdown Syntax

Markdown is a simple set of symbols that can be used as a shorthand method of changing the appearance of text, without the use of html. It allows the user to quickly and easily add headers, underline, bold, and italicize text, as well as perform more sophisticated functions such as adding links.

The following two images illustrate the use of the Markdown syntax in an Obiki document.

Sample usage while configuring a document

Markdown in edit mode

Sample markdown syntax

How it displays when the document is saved

Markdown as it is displayed

Markdown displayed

Combining Markdown with HTML

Markdown will not function within a set of html tags. If html is to be used within a display component, be sure to convert all markdown within the tags to html. Markdown in the same component, but not within the tags, is not affected. For example:

With no html tags,

[link](link.html)

Will create a link that looks like this:

link

But:

<p>[link](link.html)</p>

Will place this on your page:

[link](link.html)

And the link will not work.

< Previous: Component Types