md-syntax.md

RichMD Markdown Syntax

Basic Markdown Syntax

Heading

# heading 1
## heading 2
### heading 3
#### heading 4
##### heading 5
###### heading 6

Strong

**strong**

Italic

*strong*

Strong + Italic

***strong***

Strike Through

~~strong~~

Image

![name](path)

Link

[name](path)

List

- list1
- list2
- list3

Ordered List

1. list1
2. list2
3. list3

Checklist

- [ ] checklist
- [ ] checklist
- [x] checklist

Blockquote

> Blockquote

Horizonal

---

Inline Code

`Inline code`

Code Block

```
Code block
```

Enable Language syntax

```js
console.log('Hello World!')
```

It can display filename in code block.

```js:main.js
console.log('Hello World!')
```

It use highlight.js code syntax support. Please code syntax support details read a highlight.js Documentation.

Table

| TH | TH |
|----|----|
| TD | TD |

Original Markdown Syntax

Mathematical formula Block (Use KaTeX)

Please TeX Syntax details read a KaTeX Functions Documentation.

Syntax

$$$
\frac{a}{b}
$$$

Preview

Inline Mathematical formula

Syntax

This is $a=b+c$

Preview

Color Block

Syntax

===
**Default**:
This is default color block.
===
===primary
**Primary**:
This is primary color block.
===
===success
**Success**:
This is success color block.
===
===warning
**Warning**:
This is warning color block.
===
===danger
**Danger**:
This is danger color block.
===

Preview

Dropdown details

Syntax

:>Summary
text...
:>

Preview

Video(HTML5 Video Tag)

Syntax

@[movie](./movie.mp4)

Import CSS File(Only RichMD file is supported)

Syntax

Be sure to enter at the beginning of the line.

:style:./styles/style.css

Custom HTML Tag(Only RichMD file is supported)

Support HTML Tag

• div
• menu
• main
• section
• article
• header
• aside
• nav
• footer

Syntax

::<Tag Name>[.ClassName]

::

Example

::menu
menu
::

::article.className
article
::

::
div
::

Preview

<menu>
<p>menu</p>
</menu>

<article class="className">
<p>article</p>
</article>

<div>
<p>div</p>
</div>