On github, some elements are not rendered properly. To read a properly rendered version, visit [my blog].

MDxt

[[Giant]] MarkdDown eXTended [[/Giant]]

MDxt is an extended markdown format. Though not a strict superset of [gfm], MDxt supports most of its features. You can read more about it here

Some elements require proper CSS files to be rendered. You can either write your own, or use CSS files in this repo.

If you wanna know more about MDxt, see these articles.

• [showcase]
• [reference]

GFM compatibility

[GFM] is a Github-flavored markdown format, which is one of the most widely used markdown extension.

MDxt can read most gfm documents, but the output is different. (ex: unlike gfm, fenced code blocks are rendered to tables.) It doesn't support some of gfm's syntaxes. (ex: indented code blocks, setext headings, and a few more)

I won't make any compatibility layers for gfm (ex: GFM <-> MDxt converter). Because some elements are impossible to convert to GFM formats. They require <script> tags in their output HTML, which are not supported in GFM and most other markdown extensions.

OLD

Inline elements

It supports most inline decorations that gfm supports, and has a few more.

Underlines

~_Underlines_~ is rendered to ~Underlines~. The first and the last character may not be a whitespace.

Macros

HMD doesn't let you use raw html tags. Instead, it has plenty of macros.

Some macros have opening and closing elements, just like HTML tags! Those macros are translated directly to HTML tags. For them to be translated correctly, they should not mess up with <p> tags. So an opening macro and closing one should be in the same paragraph, or take up a single paragraph. See examples below.

``` [[red]]

This text is red!

[[/red]]

[[red]] This text is red! [[/red]] ```

Properly closed.

``` [[red]] This text is not red!

Because the closing macro is in another paragraph. [[/red]] ```

Not proper.

[[box]]

All the double square brackets are rendered to macros. If you want a square bracket inside a link text, use escape characters. [\\[link text\\]] like this.

[[/box]]

Colors

The actual colors may differ depending on css files you use.

| Name | Showcase | |:----:|:--------------------------------------------------:| | Red | [[red]] This text is red! [[/red]] | | Blue | [[blue]] This text is blue! [[/blue]] |

Backslash Escapes

Unlike gfm, backslash escapes work everywhere, even inside code blocks!

TODO

normalize어쩌구저쩌구, linkhandler 등에 특수문자를 넣어서 저 함수를 여러번 거치는 친구들이 있는지 검사

ex) normalize 함수를 거치면 결과물에 0x8000이 포함되게 하고, normalize 함수에 들어온 input에 0x8000이 포함돼 있으면 에러 던지기

div, span macro

[[div, class=class1, id=id1]] foo [[/div]], [[span, class=class1, id=id1]] foo [[/span]]

JS로 저거 제어하면 아주아주 확장성이 커질 듯?

tooltip, button

mdx engine이 mathjax 결과물까지 다 처리한 다음에 최종 결과물에는 svg만 넣으면 안되나?