Starlight Links

Visual Studio Code extension providing IntelliSense for links in Markdown and MDX files for Starlight documentation projects.

• Link completions for internal links and fragments:

  

• Go to definition and follow internal links:

  

• Hover internal links:

  

By default, the Starlight Links extension will look for Starlight configuration files located either at the root of the workspace or in a docs/ subdirectory.

You can customize the directories where the extension will look for Starlight configuration files in your Visual Studio Code User or Workspace settings.

{
  "starlightLinks.configDirectories": [".", "./docs", "./app", "./packages/docs"]
}

In multilingual documentation projects, the Starlight Links extension will, by default, limit internal link completions to the locale of the currently opened file.

You can disable this behavior and always show all internal links regardless of the locale in your Visual Studio Code User or Workspace settings.

{
  "starlightLinks.useConsistentLocale": false
}

By default, the Starlight Links extension provides IntelliSense support for links and Starlight <LinkCard> and <LinkButton> components.

You can extend this support for additional custom components in your Visual Studio Code User or Workspace settings by providing the component names and associated prop names to be treated as links.

{
  "starlightLinks.customComponents": [
    // Add support for a `<CustomLink url="…">` component.
    ["CustomLink", "url"],
  ],
}

• Toggler - Toggle words and symbols.
• Create - Quickly create new File(s) & Folder(s).
• Trailing - Toggle trailing symbols: commas, semicolons and colons.
• Starlight i18n - Easily translate Starlight documentation pages.

Licensed under the MIT License, Copyright © HiDeoo.

See LICENSE for more information.