Markdown Links in Wikantik

Wikantik uses an enhanced CommonMark parser (Flexmark) that supports both standard Markdown links and wiki-style shortcuts.

Internal Wiki Links

Internal links should point to a page's **slug** (CamelCase name) or its **canonical_id**.

1. Wiki Shortcuts (Recommended)

Use double brackets for simple, readable internal links.

- `[PageName](PageName)`

- `[Display Text](PageName)`

2. Standard Markdown Links

Standard `[text](url)` syntax also works for internal pages.

- `[PageName]()` — The empty URL triggers internal slug resolution.

- `[Display Text](PageName)` — Links directly to the slug.

3. Linking by Canonical ID

For maximum stability across page renames, use the stable ULID.

- `[Display Text](id:01KRTB67YHJ96D0PBJ1NEJDY22)`

- Wikantik will resolve the ID to the current slug at render time.

External Links

External links use standard Markdown syntax.

- `[Google](https://google.com)`

- `https://google.com` (Auto-linked)

Linking to Attachments

To link to a file attachment on the current page:

- `[Download Document](attachment:filename)`

Linking to Clusters and Tags

You can link to system-generated lists using special prefixes:

- `[Dev Cluster](cluster:wikantik-development)`

- `[Security Pages](tag:security)`

Best Practices

1. **Prefer Slugs over IDs for Humans:** Slugs are easier to read and type for human editors.

2. **Use IDs for Automated Tools:** When agents or scripts generate links, they should prefer `id:` links to prevent breakage during future renames.

3. **Avoid Extensions:** Never link to `.md` or `.txt` files directly (e.g., `[Page](Page.md)`). Use the slug only.

---

**See Also:**

- [Wiki Name](WikiName) — Understanding slugs.

- [Text Formatting Rules](TextFormattingRules) — The full syntax guide.