Syntext

A lightweight, markdownish markup language for generating HTML.

Version 2.8.0

Inline Syntax


Formatting

Single asterisks indicate italic text, double asterisks indicate bold text, triple asterisks indicate bold italic text:

This text is *italic*.
This text is **bold**.
This text is ***bold and italic***.

Backticks are used to enclose code samples:

This is a `code sample`.

HTML in code samples is automatically escaped.

Link syntax is borrowed directly from Markdown:

[link text](http://example.com)

Syntext also supports Markdown-style reference links:

[link text][ref]

Link references can be specified anywhere in the document:

[ref]: http://example.com

If the reference text is omitted from the link, the link text will be used instead when searching for link references.

Images

Image syntax is borrowed directly from Markdown:

![alt text](http://example.com/image.jpg)

Syntext also supports Markdown-style reference images:

![alt text][ref]

Image references can be specified anywhere in the document. Their form is identical to that of link references. If the reference text is omitted from the image, the alt text will be used instead when searching for references.

Dashes

Double hyphens -- are converted into en-dashes, –; triple hyphens --- are converted into em-dashes, —.

Superscripts & Subscripts

Superscripts are indicated using a caret:

X^{2}

Subscripts are indicated using an underscore:

H_{2}O

Text to be super or subscripted should be wrapped in curly braces.

Verbatim

Double backticks create a verbatim environment:

``verbatim``

The content of a verbatim environment is passed through in its raw state without any further processing.