Skip to main content

Adding Links

This tutorial will guide you through adding hyperlinks to your documentation. Links connect related content, provide references, and enhance navigation.

Determine what you want to link to:

  • An external website
  • Another section in the same document
  • A different document in your project

Use this Markdown syntax:

[Link Text](URL)

Replace Link Text with your display text and URL with the target path.

Link to external websites using the full URL:

[Visit Team Curiosity](https://teamcuriosity.com)

Link to other documents using relative paths or slugs. Slugs are URL-friendly versions of document titles (lowercase, hyphen-separated).

The default slug is (routeBasePath)/(file-path). Documents with index.mdx files use only their folder path as the slug.

Examples:

[Getting Started Guide](/getting-started)
[Texture Pack Quickstart](/getting-started/quickstart/texture-pack)
Further Reading

See the Architecture page for details on documentation structure, or refer to the Docusaurus Linking Documentation for advanced options.

Practical Examples​

Linking Within the Same Instance​

Current location: internal-docs/tutorials/adding-links.mdx

To link to internal-docs/architecture.mdx, use a relative path from the tutorials folder:

[Documentation Architecture](../architecture)

Result: Documentation Architecture

Linking Across Instances​

To link to docs/getting-started/index.mdx from any instance, use an absolute path from the site root:

[Getting Started Guide](/getting-started)

Result: Getting Started Guide

Note: The docs instance has an empty base route path, so use /getting-started directly, along with any other page you want to reference from it.
The leading / indicates the site root.

Linking from Index Files​

For index.mdx files, the working directory is the parent folder:

parentFolder/
  folder/
    index.mdx  # working directory is parentFolder
  folder2/
    page.mdx

From index.mdx to page.mdx:

[Folder2 Page](folder2/page)

Linking to the Home Page​

To link to the documentation landing page:

[SFS Modding Guide Home](/)

Result: SFS Modding Guide Home