WikiLinks

Use Obsidian-style links and embeds in markdown content.

Mental model

WikiLinks are converted to standard links/images before MDX rendering. Unresolved targets render as stub links.

Do this

Syntax reference:

[Page Name](/page-name)
[Display Text](/page-name)
[Folder/Page Name](/folder/page-name)
[#Section Heading](#section-heading)
![image](image.png)
![Alt text](path/to/image.png)

Demo links:

• Basic link: Documentation/Quickstart
• Aliased link: Open Quickstart
• Path-qualified link: Documentation/Timeline Blocks
• Section anchor link: #Resolution rules
• Cross-page link for graph/backlinks demos: Documentation/Graph View
• Stub link example: Documentation/This Page Does Not Exist Yet

Demo image embed:

Verify

• Basic/aliased/path-qualified links navigate to expected pages.
• Section anchor link scrolls to heading.
• Stub link is visually marked and treated as unresolved.
• Embedded image renders in-page.

Limits and rules

• Path-qualified links ([Folder/Page](/folder/page)) resolve directly.
• Bare links ([Page](/page)) resolve only when unambiguous.
• Bare links matching multiple pages are unresolved until path-qualified.

Authoring guidelines

• Use [Folder/Page](/folder/page) in larger vaults.
• Keep folder names meaningful.
• Use display text (|...) when path names are long.

npm run test validates route collisions and ambiguous bare WikiLinks.