Custom Protocol Links

Open configured custom URL schemes from VS Code Markdown Preview.

Why

Markdown Preview only opens a limited set of URL schemes directly. This extension routes configured custom schemes through its VS Code URI handler, then opens them with the operating system's registered application.

Setup

Add only the URL schemes that you trust to VS Code settings.

{
  "customProtocolLinks.schemes": ["exampleapp"]
}

Then use a regular Markdown link.

[Open an item](exampleapp://resource/item)

Clicking the link in Markdown Preview opens the registered application.

Development

pnpm install
pnpm test
pnpm package

pnpm package creates an installable VSIX file. Install it locally with VS Code's Install from VSIX command.

Releases

The release workflow runs when a v<version> tag is pushed, or when it is started manually from the Actions page. It checks that the tag or manual version matches package.json, runs the tests, packages the VSIX, publishes it to the Visual Studio Marketplace, and creates a GitHub Release with the VSIX attached.

Before the first automated release, add a VSCE_PAT repository secret that contains a Visual Studio Marketplace personal access token with the Manage scope.

For a tag-triggered release, update package.json, commit the change, then push the matching tag.

git tag v<version>
git push origin v<version>

Marketplace review can delay public availability. After the workflow completes, confirm the version on the Marketplace and install it from the VS Code extension gallery.

License

MIT