## Markdown Formatting Guide

This is the complete reference for formatting text in forums, wiki pages, messages, and other content areas across the platform. We use GitHub-flavored Markdown with some platform-specific extensions.

---

## Text Formatting

### Bold and Italic

```
**bold text**
*italic text*
***bold and italic***
~~strikethrough~~
```

**bold text**, *italic text*, ***bold and italic***, ~~strikethrough~~

### Superscript and Subscript

```
This is ^superscript^ text
This is ~subscript~ text
```

---

## Headings

Use `#` symbols at the start of a line. The number of `#` determines the heading level.

```
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
```

Use Heading 2 (`##`) for main sections and Heading 3 (`###`) for subsections. Heading 1 is reserved for page titles.

---

## Links

### Basic Links

```
[Link text](https://example.com)
[Link with title](https://example.com "Hover title")
```

### Auto-linked URLs

Paste a full URL and it becomes a link automatically:

```
https://support.mobieus.io
```

### Internal Links

Link to other pages in the community:

```
[Visit the forums](/forums)
[See my profile](/profile/username)
[A wiki page](/know/getting-started)
```

---

## Images

### Inline Images

```
![Alt text](https://example.com/image.jpg)
![Screenshot](/uploads/images/screenshot.png)
```

### Uploading Images

In the wiki editor and post composer, you can:

- Click the **Image** button in the toolbar
- **Drag and drop** an image onto the editor
- **Paste** a screenshot from your clipboard (Ctrl+V / Cmd+V)

The image uploads automatically and the markdown is inserted at your cursor.

### Image Sizing

Images display at their natural size up to the content width. There is no markdown syntax for resizing (use the upload at the desired resolution).

---

## Lists

### Bullet Lists

```
- First item
- Second item
  - Nested item
  - Another nested item
- Third item
```

- First item
- Second item
  - Nested item
  - Another nested item
- Third item

### Numbered Lists

```
1. First item
2. Second item
3. Third item
```

1. First item
2. Second item
3. Third item

### Task Lists

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

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

---

## Blockquotes

```
> This is a blockquote.
> It can span multiple lines.
>
> And have multiple paragraphs.
```

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

### Nested Quotes

```
> First level
>> Second level
>>> Third level
```

---

## Code

### Inline Code

```
Use `backticks` for inline code like `variable` or `function()`.
```

Use `backticks` for inline code like `variable` or `function()`.

### Code Blocks

Use triple backticks for multi-line code. Add a language name after the opening backticks for syntax highlighting.

````
```javascript
function greet(name) {
    return "Hello, " + name;
}
```
````

Supported languages include: javascript, python, php, html, css, sql, bash, json, xml, yaml, ruby, go, rust, java, c, cpp, csharp, typescript, markdown, and many more.

### Indented Code

Indent with 4 spaces for a code block (no syntax highlighting):

```
    This is a code block
    created with indentation
```

---

## Tables

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

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

### Column Alignment

```
| Left     | Center   | Right    |
|:---------|:--------:|---------:|
| Left     | Center   | Right    |
```

Use `:` on the left for left-align, both sides for center, right side for right-align.

---

## Horizontal Rules

Three or more dashes, asterisks, or underscores on their own line:

```
---
***
___
```

---

## Mentions

Tag another user with `@` followed by their username:

```
@username
```

The editor provides autocomplete suggestions as you type after `@`. The mentioned user receives a notification.

---

## Emoji

You can use standard Unicode emoji by typing or pasting them directly. The emoji picker in the post composer provides a visual browser.

Common examples: :) :( :D <3

---

## HTML Support

A limited subset of HTML is allowed for advanced formatting:

**Allowed tags:** `<p>`, `<br>`, `<strong>`, `<b>`, `<em>`, `<i>`, `<u>`, `<a>`, `<ul>`, `<ol>`, `<li>`, `<code>`, `<pre>`, `<blockquote>`, `<h1>`-`<h6>`, `<img>`, `<hr>`, `<del>`, `<s>`, `<sup>`, `<sub>`, `<span>`, `<table>`, `<thead>`, `<tbody>`, `<tr>`, `<th>`, `<td>`, `<div>`

**Stripped on save:** `<script>`, `<iframe>` (except from approved embed hosts), event handlers (`onclick`, `onload`, etc.), inline JavaScript.

---

## Line Breaks

A single newline in markdown does not create a line break. To force a line break:

- Leave a blank line between paragraphs (creates a new `<p>`)
- End a line with two spaces followed by Enter (creates a `<br>`)
- Use `<br>` directly

```
Line one (two trailing spaces)
Line two

Or a blank line for a new paragraph.
```

---

## Escaping Special Characters

Prefix any markdown character with a backslash to display it literally:

```
\*not italic\*
\# not a heading
\[not a link\]
\`not code\`
```

Characters that can be escaped: `\` `` ` `` `*` `_` `{` `}` `[` `]` `(` `)` `#` `+` `-` `.` `!` `|`

---

## Platform-Specific Features

### Post Mentions

```
@username — mentions a user (sends notification)
```

### Gallery Embeds

In forum posts, you can embed a photo gallery inline:

```
[gallery=123]
```

Where `123` is the album ID.

### Video Embeds

Paste a YouTube, Vimeo, or other supported video URL on its own line and it auto-embeds as a player.

---

## Tips for Good Formatting

1. **Use headings** to organize long content. Start with `##` for sections.
2. **Keep paragraphs short.** One idea per paragraph. Blank lines between paragraphs.
3. **Use lists** for steps, features, or items. Easier to scan than paragraphs.
4. **Add code blocks** when sharing commands, configuration, or code. Always specify the language.
5. **Use tables** for structured comparisons. Keep columns concise.
6. **Include images** to illustrate complex topics. Add descriptive alt text.
7. **Link to other pages** within the community using relative URLs like `/know/page-slug`.

## Where Markdown works

Markdown now renders in more places than forums and the knowledge base. It also works in support tickets (both the request and replies), course summaries and descriptions, member profiles, and marketplace listings. A formatting toolbar sits above these boxes, so you can add a heading, a list, a quote, or a table without remembering the syntax. What you type is what your readers see.