Markdown

Reader\Markdown\MarkdownReader reads Markdown into a UJO document. It never throws: a construct that is not well formed stays text. The document is normalized by phil/ujo before it is returned, so its inline HTML is in the canonical form of the inline tools — <b>, <i>, <s class="cdx-strikethrough">, <code class="inline-code">.

$reader = new MarkdownReader();                  // raw HTML escaped
$reader = new MarkdownReader(rawHtml: true);     // raw HTML kept, for a purifier at the level `all`
$reading = $reader->read($source);               // Reading: document and metadata

A second argument replaces the Normalizer; the default one registers every type of phil/ujo and raw. A third gives a MarkdownDialect, the syntax a dialect adds or reads differently: see Extension points.

Blocks

A container — a quote, a list item, a footnote — holds only inline content in UJO: its paragraphs are joined by line breaks, a code block becomes inline code, a heading its text. Containers nest five deep; deeper, their markers are text.

A heading's anchor is the {#id} written after it, or a slug of its text as GitHub makes it — lower case, accents of Latin letters dropped, other runs of characters a hyphen —, unique in the document: a second heading of the same text takes -1.

Inline elements

Attributes

Braces after a heading, # Title {#id .class}, or alone on the line right under a block, {.class #id} — or, in the grammar of the {{ }} blocks, {class,#id,property:value} — apply to that block:

Braces right after an image, ![a](a.png){width:200px,wrapLeft}, apply to the image.

Raw HTML

Raw HTML is kept or escaped, as the reader is built. DefaultCompiler keeps it for the level all, where an editor writes and the purifier keeps safe elements, and escapes it below, where it would only be removed: a member's <script> reads as text instead of vanishing. A kept HTML block is a raw block, sanitized by phil/ujo then purified at the level; an HTML comment alone is dropped. Inline HTML is sanitized with the inline tools of phil/ujo.

::: blocks

::: name Title opens a block closed by a line of :::; blocks nest. The name is a class, mapped as the classes of the {{ }} blocks are: note and descriptive take the title, or the heading they start with; warning makes a warning; info, success, danger, primary, secondary, light and dark an alert of that type; wide a wide block; any other class a container. ::: {.class #id} takes attributes instead.

Blocks in braces

A line {{tags opens a block, a line }} closes it, and blocks nest. The tags are separated by commas: a word is a class, #id the identifier, property:value a style. The first class UJO knows decides the type:

The identifier becomes the anchor tune, and text-align, position, offsets and size the tunes of attributes. Braces on the line under any block, {color:purple,text-align:center}, apply the same way; a CSS property UJO has no place for is left out.

A span alone on its line, {{tags content}}, may be a block of the page; any other stays text:

Spans nest 8 deep within their line.

Pages and columns

Stat blocks

{{monster,frame
## Gibbering Duck
*Small beast, chaotic gossipy*
___
**Armor Class**
: 15 (chain mail, shield)

___
|  STR  |  DEX  |
|:-----:|:-----:|
|10 (+0)|14 (+2)|
___
***Pack Tactics.*** These guys work together.
### Actions
***Bite.*** *Melee Weapon Attack:* +4 to hit.
}}

The first heading is the name, an italic line right after it the subtitle. A rule ___ or a heading starts a section, the heading its title. Definitions are the section's properties, the label without its colon; a table of two rows whose second holds scores — 10 (+0), 14 — its abilities, each a label, a score and a modifier; any other block stays in the section's blocks. frame and wide set the flags of the same name.