Markdown Reference

Headings

Use # symbols at the start of a line. One # for h1, up to six for h6.

# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6

In Doc Builder, headings h1–h3 are automatically extracted and shown as anchor links in the TOC sidebar.

Emphasis

Wrap text with asterisks or underscores for bold and italic. Use ~~ for strikethrough.

Lists

Unordered lists use -, *, or +. Ordered lists use numbers followed by a period. Nest by indenting with two spaces.

- Item one
- Item two
  - Nested item
  - Another nested
- Item three

1. First item
2. Second item
   1. Nested ordered
   2. Another nested
3. Third item

Task Lists

GFM extension. Use - [ ] for unchecked and - [x] for checked. Renders as checkboxes in the preview.

- [x] Write the overview
- [x] Add code examples
- [ ] Review and publish
- [ ] Add screenshots

Links & Images

Links use [text](url). Images use the same syntax with a leading !. Reference-style links separate the URL definition from the usage.

<!-- Inline link -->
[DevForge](https://devforge.app)

<!-- Link with title tooltip -->
[DevForge](https://devforge.app "Developer Workbench")

<!-- Image -->
![Alt text](https://example.com/image.png)

<!-- Reference-style link -->
[DevForge][devforge-ref]

[devforge-ref]: https://devforge.app

Code

Fenced code blocks use three backticks. Add a language identifier immediately after the opening fence for syntax highlighting.

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

```bash
npm install
npm run dev
```

```json
{
  "name": "devforge",
  "version": "1.0.0"
}
```

Common language identifiers: typescript, javascript, python, bash, sql, json, yaml, css.

Blockquotes

Prefix lines with >. Blockquotes can be nested and can contain other Markdown elements.

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

> Outer quote
> > Nested inner quote

Tables

GFM extension. Columns are separated by |. The second row defines column alignment using colons.

| Name       | Type    | Description          |
| ---------- | ------- | -------------------- |
| id         | string  | Unique identifier    |
| createdAt  | date    | Creation timestamp   |
| active     | boolean | Whether enabled      |

<!-- Column alignment -->
| Left   | Center  | Right  |
| :----- | :-----: | -----: |
| text   | text    | text   |

Alignment: :--- left (default), :---: center, ---: right.

Horizontal Rules

Three or more hyphens, asterisks, or underscores on their own line. Leave a blank line before and after to avoid ambiguity with headings.

Section one content.

---

Section two content.

Escaping

Prefix a special character with \ to render it literally instead of as Markdown syntax.

*not italic*
# not a heading
[not a link](url)
`not code`

Escapable characters: \ ` * _ { } [ ] ( ) # + - . !

Wikilinks (DevForge)

Use double brackets to link between files in the same workspace. The slug is the filename without the .md extension, with spaces replaced by hyphens.

<!-- Link to another file in the workspace -->
[[api-reference]]
[[setup-guide]]
[[changelog]]

<!-- Rendered as a clickable link in the preview -->
<!-- Clicking switches the active file in the workspace -->

A wikilink to a file that does not exist in the workspace renders in muted style as a dead link, until the matching file is created.