Markdown syntax

This document describes the modified Markdown syntax supported by the engine.

Headings and text

As in plain Markdown, headings use the # syntax:

# Main heading
Text goes here.

## Subtitle
Some more text here.

Links

Links are supported with the following syntax only:

Follow [this link](https://mylink.net) and see you.

Optionally, a title can be specified:

Follow [this link](https://mylink.net "Just click me") and see you.

Media to display

Images, video and media to display:

![Alt text](https://mymedia.net)

Note: Needs to be in its own paragraph.

Quote

Quotation is performed via the > operator:

> This is a quote
> which can span on more lines

Lists

As in plain Markdown:

- Item A
- Item B
- Item C

1. Item 1
2. Item 2
3. Item 3

Automatic counting:

+ Item 1
+ Item 2
+ Item 3

Mixing also possible:

- Bullet 1
- Bullet 2
    1. Item 1
    2. Item 2
- Bullet 3
    + Item 11
    + Item 12

Code blocks

Using triple back-tick:

```
This is a code block.
```

To do inline, using single:

`This is inline`

Inline formatting

Italic is achieved like: *Italic* or _Italic_. Bold can be set using: **Bold** or __Bold__.

---

Additional formatting is available.

Equations

Equations can be added by using the dollar sign: $.

This is an inline equation showing the Fourier Transform: $F(f) = \int_{-\infty}^{+\infty}e^{-2\pi i y t}f(t)dt$.

A block equation is generated by using the double dollar sign:

$$
F(f) = \int_{-\infty}^{+\infty}e^{-2\pi i y t}f(t)dt
$$

Note: Needs to be in its own paragraph.

Note: The block equation will always generate a numbered environment.

To avoid creating a numbered environment, use an asterisk:

$$*
F(f) = \int_{-\infty}^{+\infty}e^{-2\pi i y t}f(t)dt
$$

Footnote

To create a footnote, use symbol: ^:

This is a strange term^[A better description is provided].

Extra environments

Theorems, definitions, propositions, corollaries, lemmas can be defined as follows:

theorem Title
===

Body of the theorem.

Example:

theorem Residue Theorem
=======================
:[thm-res]
The line integral  on a closed curve of a complex function $f(z)$ is equal to:

$$
\oint_\Omega f(z)dz = 2\pi i \sum_k \text{Res}[f, z_k]
$$

Note: Needs to be in its own paragraph. Also, this extends until triple newline or another environment starts.

Text references and labels

A label is created with: :[label-name], and used with: @[label-name]. Example:

## Subtitle
:[sec-1]
This is a section.

## Another section
As references in section @[sec-1], something.

Note that @[label] can be used to reference an environment:

~[theorem "thm-res"](Residue Theorem)
The line integral  on a closed curve of a complex function $f(z)$ is equal to:


As explained by theorem @[thm-res], this is cool.

Text variables

To help avoid repetitions, text variables can be defined using: :[variable-name](Value), and used by employing the syntax for references: @[variable-name].

Inclusion directives

All directives start with symbol %. To include another file:

%include "path/to/file"

With or without extension.