Skip to content
Documentation

Cross-Project Links

updated

When your workspace has multiple projects, you can link between them using cross-project magic links.

Syntax

Add the project alias before the document alias, separated by :::

[[project-alias::document-alias]]

For example, if you had a project called engineering with a document aliased api-guide, you’d write:

[[engineering::api-guide]]

You can also add a custom label:

[[engineering::api-guide|API Guide]]

Cross-project links are useful when you have related documentation split across projects:

  • A product project linking to engineering specs
  • A design system project linking to component docs
  • An onboarding project linking to team processes

Note: Since this is a fresh workspace with only the demo project, cross-project links are shown here as code examples. Once you create more projects, you can use them for real.

See also