! TypoML


!! Installation

TypoML requires the Odin compiler. Build from source:

```
make build
```

This creates the TypoML executable in the current directory. (wow, how unexpected)

!! Usage

TypoML reads from stdin and outputs HTML to stdout:

```
cat input.tlm | ./TypoML > output.html
```

!! Syntax

!!! Text Formatting

`*` - *italic* - Italic text
`**` - **bold** - Bold text
`***` - ***bold italic*** - Bold and italic
`--`/`~~` - --strikethrough-- - Strikethrough text
`__` - __underlined__ - Underlined text
`_` - H_2_O_4_U - Subscript
`^` - Δ = b^2^ - 4ac - Superscript

!!! Headings

\! Heading 1
\!! Heading 2
\!!! Heading 3
(And so on)

!!! Links

\#[Link text](url) - Standard link
\#(url)[Link text] - Can go either way
\#[url] - Auto-link (no alt text)
[Link text](\#heading) - Header link (anchor) (can also be done like an auto-link, then the text is auto-generated from the heading)

!!! Alignment

Placed at the end of start of a line

\>> - Right aligned
\<< - Left aligned
\^^ - Center aligned

!!! Embedded Content

\$[url] - Auto-detect type
\$(url) - Can also be done like this

To force a specific type, use \$[url|type]

Types:

- `image`, `img`, `i`
- `audio`, `a`
- `video`, `v`
- `iframe`, `frame`, `f`
- `script`, `s`, `javascript`, `js`

!!! Lists

- Item 1
. Item 2

Unordered lists use - or . as markers.

1. First item
2. Second item

Ordered lists use numbers followed by periods.

!!! Code Blocks

```language
code here
```

Inline code uses backticks: `code`

!!! Tables

| Header 1 | Header 2 | Header 3 |
|---|---|---|
| Cell 1 << | Cell 2 >> | Cell 3 ^^ |

Do not need a header to work, just the first separator row (`|---|---|---|`)
Can be aligned using the alignment markers

!!! Blockquotes

\> This is a blockquote
\> Multiple lines are supported

!!! Footnotes

[\&footnote] - Footnote reference
[\&&footnote] - Footnote definition

Can be numbers or names

!!! Variables

\$(name=value) - Define a variable
\$(name) - Use a variable

!!! Script Blocks

\$[script]
JavaScript code here
\$[/script]

!!! Escaping

Standard escaping using a backslash (`\`)

!!! Horizontal Rules

\--\-, \__\_, or \==\=

Three or more, have to be on their own line