Writing Markdown

What is Markdown?

Markdown is a plain text format for writing structured documents.

Where Markdown is available

Markdown is available for description, license, and discussion.

Syntax

Escaping

Use \ to supress the special characters defined by syntax.

# this is heading
\# this is not heading

Heading

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

Level 2 heading
---------------

Paragraph

paragraph1
paragraph1

paragraph2

Bold

**bold text**
__bold text__

Italic

*italic text*
_italic text_

Blockquote

> quoted paragraph

List

Ordered list

1. first item
2. second item
3. third item

Unordered list

- first item
- second item
- third item

Code

Block code

```
verbatim text
```

```language
highlighted code in specified language
```

There are special language names for this syntax. They will effect

language effect
math renders math equations (see below)
mermaid renders diagrams (see below)
delikasql shows a button to run the query in the code block

Inline code

`code`
[text](URL)

Image

![alt text](URL)

Table

| heading | left-aligned | centered-aligned | right-aligned |
| --- |:--- |:---:| ---:|
| cell | cell | cell | cell |
| cell | cell | cell | cell |

Horizontal rule

---

Math

delika uses KaTeX to render math. See supported functions by KaTeX.

Block math

$$
LaTeX math notation
$$

Inline math

$ LaTeX math notation $

Diagram

delika uses Mermaid to render diagrams such as entity relation diagrams. See diagram syntax by Mermaid for details.

```mermaid
diagram
```

Emoji

Emoji

:emoji_name:

For examples: :+1: :-1: :heart_eyes:

Smiley

For examples: :) :D

Arrow

-> <-> <-
=> <=> <=