Skip to content
Documentation

Magic Links

updated

Magic links are the easiest way to connect documents within Meldoc. Instead of copying URLs, you just reference a document by its alias.

Basic syntax

Wrap an alias in double square brackets:

[Welcome to Meldoc](/demo-project/demo/demo-welcome)

This renders as a clickable link: Welcome to Meldoc

Custom labels

You can change the display text with a pipe character:

[Welcome to Meldoc](/demo-project/demo/demo-welcome)

This renders as: Welcome to Meldoc

  • They never break — even if a document’s title changes, the alias stays the same
  • They autocomplete — type [[ in the editor and start typing to see suggestions
  • They’re readable — [[demo-markdown]] tells you exactly where the link goes

Try it in the editor

  1. Click Edit on this page
  2. Place your cursor somewhere in the content
  3. Type [[ — you’ll see an autocomplete dropdown
  4. Start typing a document name to filter the list
  5. Select a document and it will insert the magic link for you

See also

  • [[demo-linking|Back to Linking Your Docs]] — other link types
  • Frontmatter Reference — where aliases are defined