MDxt Reference

MDxt is an extended version of Markdown.

Inline Elements

Code spans

`abc` is rendered to <code class="short">abc</code>. If the first and the last character of the code span is a whitespace, both are ignored. If a code span opens with n `s, it has to be closed with the same number n of `s.

Italic

*abc* is rendered to <em>abc</em>. The inner text may not start/end with whitespace(s).

Bold

**abc** is rendered to <strong>abc</strong>. The inner text may not start/end with whitespace(s).

Underline

~_abc_~ is rendered to <u>abc</u>. The inner text may not start/end with whitespace(s).

Deletion

~~abc~~ is rendered to <del>abc</del>. The inner text may not start/end with whitespace(s).

_Subscript

~abc~ is rendered to <sub>abc</sub>. The inner text may not start/end with whitespace(s).

^Superscript

^abc^ is rendered to <sup>abc</sup>. The inner text may not start/end with whitespace(s).

Links

Images

A valid link after a bang(!) character is rendered to an img tag.

![abc](def) is rendered to <img src="def" alt="abc">.

Footnotes

This is a footnote.[^A]

This is another footnote.[^B]

[^A]: Hi, there!
[^B]: Hello!

This is a footnote.^[0]

This is another footnote.^[1]

Containers

Headers

### Headers is rendered to <h3>Headers</h3>.

Tables

Column Alignments

Multiline Table Head

Colspan

Collapsible Tables

| Click Me! (Default shown)              |
|----------------------------------------|
|!![[collapsible, default=shown]]        |
| Hi, there!                             |

| Click Me! (Default hidden)            |
|---------------------------------------|
|!![[collapsible, default=hidden]]      |
| Hi, there!                            |

Lists

Task list

- [ ] Unchecked
- [X] Checked
- [^] Not yet

• Unchecked
• Checked
• Not yet

Fenced Code Blocks

Fenced code blocks are rendered to <table> tags in html. Be aware if you're writing custom css files for mdxt.

```rust, line_num, highlight(6, 17, 22)
/*
    multiline
    comment
*/
// single line comment
fn main() {
    let mut x = 3;
    let mut y = if x == 3 {
        4
    } else {
        5
    };
    let z = x < 3 && y > 4;
    println!("Hello World!\n");
    println!("{:?}", 3 + 4);
}

pub struct Point {
    x: f32,
    y: f32
}

pub const CONST: u32 = 1;
```

1/*
2    multiline
3    comment
4*/
5// single line comment
6fn main() {
7    let mut x = 3;
8    let mut y = if x == 3 {
9        4
10    } else {
11        5
12    };
13    let z = x < 3 && y > 4;
14    println!("Hello World!\n");
15    println!("{:?}", 3 + 4);
16}
17
18pub struct Point {
19    x: f32,
20    y: f32
21}
22
23pub const CONST: u32 = 1;
Copy

Blockquotes

This is a blockquote.

This is another blockquote.

Metadata

Unlike GFM...

MDxt doesn't support setext headers and indented code blocks.

Macros

Macros are inline elements. Which means an opening macro and the closing one has to be in the same paragraph. But there are many cases where you want to apply macros to multiple paragraphs. Read multiline macro section for that.

A valid macro consists of A-Z, a-z, 0-9, =, ,, _, and . If a double square bracket contains invalid characters, that won't be parsed as a macro. Whitespaces and _s inside macros are ignored, and all the alphabet characters are lowered. That means [[box, no_border]] and [[box, n o border]] are exactly the same macro.

Colors

It has 14 colors: black, dark, gray, lightgray, white, red, green, blue, aqua, emerald, violet, pink, grassgreen, and gold.

Sizes

It has 5 sizes: tiny, small, medium, big, and giant.

[[tiny]] tiny [[/tiny]] is rendered to <span class="size-tiny"> tiny </span>. The same rule is applied to the other sizes.

Alignments

It has 3 alignments: left, right, and center.

[[center]] center [[/center]] is rendered to <span class="align-center"> center </span>. The same rule is applied to the other alignments.

Inline alignments are rendered to span tags and multi-lines are rendered to div. In most cases, span tags don't work with alignments.

Highlights

[[highlight = red]] This text is highlighted! [[/highlight]] is rendered to <span class="highlight-red"> This text is highlighted! </span>. The same rule is applied to the other colors.

To see available colors, read the Colors section.

Box

[[box]]A text in a box.[[/box]] is rendered to <div class="box">A text in a box.</div>.

[[box, no border]]A text in a box.[[/box]] is rendered to <div class="box no-border">A text in a box.</div>.

[[box]]

A paragraph in a box.

[[box]]

A paragraph in a box in a box.

[[/box]]

[[box, no border]]

A paragraph in a borderless box in a box.

[[/box]]

[[/box]]

Table of Contents

| Table of Contents |
|-------------------|
|!![[collapsible]]  |
| [[toc]]           |

See how the above code is rendered, see here.

Special Characters

[[char = 44032]] is rendered to 가, which is 가.

[[char = copy]] is rendered to ©, which is ©.

To see the list of available characters, visit here.

Icons

WIP

Math

[[math]] sqrt{sup{a}{2} + sup{b}{2}} [[/math]] is rendered to $\sqrt{a^2+b^2}$. It renders the output in MathML.

To see the list of available math elements, visit here.

Multiline Macro

If a paragraph has a macro and no other contents at all, the paragraph is rendered to a multiline macro.

[[red]]

These 3 paragraphs are

rendered to

red texts.

[[/red]]

As you see above, the first and the last paragraph only consist of a macro. The macro will be rendered to <div class="color-red">.

Plugins

WIP

Characters

Escapes

Backslashes (\) inside code spans and fenced code blocks are not escaped. All the other backslash characters are escape characters.

Tabs

All the tab characters (\t) are converted to 4 whitespaces. All the newline characters except \n are ignored.

0. [0] Hi, there!
1. [1] Hello!