Dorcs
Edit on GitHub

Special Markdown

These patterns are especially useful in docs content.

Front matter

Put YAML front matter at the top of the file:

---
title: "API Overview"
description: "What the API covers"
draft: false
---

Write links to local Markdown files naturally:

[Auth guide](/06_markdown/auth)

Dorcs serves the target as a clean extensionless URL.

GitHub-style callouts

Dorcs supports GitHub alert syntax:

> **ALERT:NOTE**
> This is a note.

> [!TIP]
> This is a tip.

Supported types:

  • NOTE
  • TIP
  • IMPORTANT
  • WARNING
  • CAUTION

Images

![Diagram](/06_markdown/images/diagram.png)

Keep image paths relative to the current file unless you intentionally want shared root-based assets.