Syntext

A lightweight, markdownish markup language for generating HTML.

Version 2.0.0

Miscellanea


Escapes

The following characters can be escaped by a preceding backslash:

! " # $ % & \ ' ( ) * + , - . / : ; < = > ? @ [ ] ^ _ ` { | } ~ •

Escaped characters lose any special significance they might otherwise have.

Tables of Contents

Syntext can automatically generate a table of contents for a document. This table can be inserted using the insert tag:

::: insert toc

The default listing skips H1 headings to avoid including the document title itself. A full listing of all the document's headings can be inserted using the fulltoc keyword:

::: insert fulltoc

The table of contents is generated as an unordered list of links.

Footnotes

Syntext includes built-in support for footnotes:

This sentence ends with a footnote reference.[^1]

Footnote references can omit their index to take advantage of automatic numbering:

This sentence ends with an automatically-numbered
reference.[^]

Footnotes themselves can be specified anywhere in the document using the footnote tag:

::: footnote 1
    This is a footnote. It can contain any kind of
    block-level markup.

Footnotes can also omit their index to take advantage of automatic numbering:

::: footnote
    This is an automatically-numbered footnote.

Note that footnote indices do not have to be numeric. Any sequence of non-whitespace characters can be used.

You can specify the insertion point for your footnotes using the insert tag:

::: insert footnotes

Footnote references are wrapped in the following markup:

<sup class="footnote-ref" id="footnote-ref-123">
    <a href="#footnote-123">123</a>
</sup>

Footnotes are wrapped in the following markup:

<div class="footnote" id="footnote-123">
    <div class="footnote-index">
        <a href="#footnote-ref-123">123</a>
    </div>
    <div class="footnote-body"> ... </div>
</div>

Each footnote is backlinked to its reference in the document.