Wiki Links

Write [[page]] to link to another page without knowing where it lives in the tree.

The four forms

[[quick-start]] → links, labelled with the target's own title
[[quick-start|start here]] → links, labelled "start here"
[[quick-start#prerequisites]] → links to a section
[[quick-start#prerequisites|Step one]] → both

An anchor with no target points within the current page:

[[#the-four-forms]]

How a target is resolved

Three lookups, in order. The first that matches wins:

Matching ignores case, a leading slash, and a trailing .md, so [[/Getting-Started/Quick-Start.md]] resolves the same as [[quick-start]].

Ambiguity is refused, not guessed

If a shorthand matches more than one page — say two folders both contain overview.md — the link is not resolved. Silently picking one would make the destination depend on the order files happen to be scanned in, which is the kind of bug nobody notices until the wrong page ships.

Use the full path to disambiguate:

[[api/overview]] instead of [[overview]]

Broken links are visible

A target that resolves to nothing renders as marked-up text rather than an anchor. Writing [[a page that does not exist]] produces:

A link to a page that does not exist looks like this.

A link that goes nowhere is worse than visibly broken text, because it looks clickable and silently is not. Hover it to see the target that failed.

List every unresolved link across the whole site:

npm run check:links

Wiki links inside code are left alone

Only prose is scanned, so documentation that explains the syntax — like this page — can show it literally:

[[this stays as written]]

Inline code works the same way: [[quick-start]] here is untouched.

Ordinary Markdown links still work

Wiki links are a convenience, not a replacement:

[Quick Start](/getting-started/quick-start)
[Quick Start](getting-started/quick-start.md)

Both resolve to the same URL under either URL strategy. Use whichever reads better; both count toward backlinks.

Why link by name

Wiki links survive reorganisation. Move quick-start.md into a different folder and every [[quick-start]] still resolves — only links written as full paths need updating.

Next

• Graph & Backlinks — see what links where
• Validation & Testing — catch broken links before you deploy