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 uses highlight.js for code syntax support. Please read highlight.js Documentation for details.

Table

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

Original Markdown Syntax

Mathematical Formula Block (using KaTeX)

Please read KaTeX Functions Documentation for TeX syntax details.

Syntax

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

or

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

Preview

Inline Mathematical Formula

Syntax

This is $a=b+c$

Preview

Color Block

Syntax

===
**Default**:
This is default color block.
===
===info
**Infomation**:
This is Infomation 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)

Custom HTML Tag

It creaties custom HTML Tag. (defalut tag span)

Syntax

::<Tag Name>[.ClassName]

::

Example

::menu
menu
::

::article.className
article
::

::div
div
::

# only className
::.className
only Class
::

Preview

<menu>
<span class="span">menu</span>
</menu>

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

<div>
<span class="span">div</span>
</div>