Markdown Basics

eziwiki supports full GitHub Flavored Markdown (GFM). This guide covers all the syntax you need.

Headings#

# Heading 1

## Heading 2

### Heading 3

#### Heading 4

##### Heading 5

###### Heading 6

Text Formatting#

**Bold text**
_Italic text_
**_Bold and italic_**
~~Strikethrough~~
`Inline code`

Bold text Italic text Bold and italic Strikethrough Inline code

Lists#

Unordered Lists#

- Item 1
- Item 2
  - Nested item 2.1
  - Nested item 2.2
- Item 3

• Item 1
• Item 2
  • Nested item 2.1
  • Nested item 2.2
• Item 3

Ordered Lists#

1. First item
2. Second item
3. Third item
   1. Nested item 3.1
   2. Nested item 3.2

1. First item
2. Second item
3. Third item
   1. Nested item 3.1
   2. Nested item 3.2

Task Lists#

- [x] Completed task
- [ ] Incomplete task
- [ ] Another task

• Completed task
• Incomplete task
• Another task

Links#

[Link text](https://example.com)
[Link with title](https://example.com 'Title text')
[Internal link](/getting-started/quick-start)

Link text Link with title Internal link

Images#

![Alt text](/images/screenshot.png)
![Alt text with title](/images/screenshot.png 'Image title')

Code Blocks#

Inline Code#

Use `const` instead of `var` in JavaScript.

Use const instead of var in JavaScript.

Code Blocks with Syntax Highlighting#

```javascript
function greet(name) {
  return `Hello, ${name}!`;
}
```

function greet(name) {
  return `Hello, ${name}!`;
}

See Code Blocks for more details.

Blockquotes#

> This is a blockquote.
> It can span multiple lines.
>
> > Nested blockquote

This is a blockquote. It can span multiple lines.

Nested blockquote

Tables#

| Header 1 | Header 2 | Header 3 |
| -------- | -------- | -------- |
| Cell 1   | Cell 2   | Cell 3   |
| Cell 4   | Cell 5   | Cell 6   |

Alignment#

| Left | Center | Right |
| :--- | :----: | ----: |
| L1   |   C1   |    R1 |
| L2   |   C2   |    R2 |

Horizontal Rules#

---
---

---

HTML in Markdown#

You can use HTML tags in Markdown:

<div style="color: red;">
  This text is red.
</div>

<details>
  <summary>Click to expand</summary>
  Hidden content here.
</details>

Escaping Characters#

Use backslash to escape special characters:

\*Not italic\*
\[Not a link\]
\`Not code\`

*Not italic* [Not a link] `Not code`

Line Breaks#

Two spaces at the end of a line create a line break:

First line  
Second line

Or use a blank line for a paragraph break:

First paragraph

Second paragraph

Footnotes#

Here's a sentence with a footnote[^1].

[^1]: This is the footnote content.

Here's a sentence with a footnote¹.

Maths#

Wrap an expression in $ to set it inside a sentence, or in $$ to give it a line of its own:

The mass–energy relation is $E = mc^2$.

$$
\int_0^1 x^2 \, dx = \frac{1}{3}
$$

The mass–energy relation is $E = mc^2$.

Typesetting happens during the build, so the page arrives with the formula already drawn — no maths library is downloaded, and nothing shifts into place after the text has settled.

Escape a literal dollar sign as \$. Two unescaped ones on the same line are read as a formula, so $5 and $7 becomes maths rather than two prices.

Emoji#

Write the character itself:

😊 ❤️ 🚀 🎉

😊 ❤️ 🚀 🎉

Shortcodes like :smile: are left alone rather than expanded. The character is what ends up in the HTML either way, and it reads the same in the source file.

Callouts#

A blockquote opening with [!KIND] becomes a callout. The syntax is GitHub's and Obsidian's alike, so a document written for either renders here, and one written here still reads as an ordinary quote anywhere that does not know the convention.

> [!NOTE]
> Useful information.

> [!WARNING] Mind the gap
> A title on the marker line replaces the default.

> [!TIP]- Optional detail
> A trailing `-` folds it away; `+` starts it open.

Five kinds carry their own colour — note, tip, important, warning and caution. Obsidian's longer list is accepted too and maps onto the nearest of them, so a vault keeps its formatting: danger reads as caution, success as tip, question as important.

An unrecognised kind stays an ordinary blockquote rather than being rendered as something it is not. Everything inside a callout behaves as it does outside — links, wiki links, and code all work normally.

Best Practices#

Use Descriptive Link Text#

✅ Good: [Read the installation guide](/getting-started/installation)
❌ Bad: [Click here](/getting-started/installation)

Keep Lines Short#

Break long lines for better readability:

✅ Good:
This is a long paragraph that has been broken into
multiple lines for better readability in the source.

❌ Bad:
This is a long paragraph that goes on and on without any line breaks making it hard to read in the source file.

Use Consistent Formatting#

✅ Good:

- Item 1
- Item 2
- Item 3

❌ Bad:

- Item 1

* Item 2

- Item 3

Add Alt Text to Images#

✅ Good: ![Dashboard screenshot showing user analytics](/images/dashboard.png)
❌ Bad: ![](/images/dashboard.png)

Next Steps#

• Learn about Frontmatter
• Explore Code Blocks
• Create Your First Wiki