Text Component Formatting

This page is a brief description of basic text formatting features – For a full specification, see the Structured Text Version 1.0 spec page.

The easiest way to write text in an MKDoc document is to create a text component and start typing, there is no need to worry about formatting or HTML, everything is joined-together naturally by the MKDoc software.

MKDoc uses some simple traditional rules to format your text. For example, you create multiple paragraphs by just leaving an empty line before starting the next.

Headings

More advanced text formatting such as titles or headlines can be used, MKDoc understands a traditional typewriter style of adding this kind of emphasis:

This is a large heading
=======================

Turn some text into a large heading by adding a row of
equal signs underneath.

This is a smaller heading
-------------------------

Small headings are created exactly the same way but
with dashes instead of equal signs.

Which then appears like this when you view the web-page:

This is a large heading

Turn some text into a large heading by adding a row of equal signs underneath.

This is a smaller heading

Small headings are created exactly the same way but with dashes instead of equal signs.

Lists

Some other formatting that MKDoc understands is lists of items, just add an asterisk to the start of each line and this will appear as a proper bullet, or use numbers with dots to create a numbered list:

* This is a bulleted list.
* This is a bulleted list.
* This is a bulleted list.

1. This is a numbered list.
2. This is a numbered list.
3. This is a numbered list.

This is a bulleted list.
This is a bulleted list.
This is a bulleted list.

This is a numbered list.
This is a numbered list.
This is a numbered list.

Text Emphasis

You can make words strong and emphasised using asterisks and underscores.

You can make *words strong* and _emphasised_ using asterisks and
underscores.

Document Links

HTML Component documentation: Help with formatting HTML.
http://mkdoc.org.archived.website/help/1-0/documents/content/html/

Structured Text Version 1.0 spec: Structured Text Version 1.0 spec
http://mkdoc.org.archived.website/help/specs/structured-txt/