Markdown Region Navigator

Local VS Code extension for Markdown files that use VS Code-style region markers and VitePress @include references.

It understands regions like:

<!-- #region vpn-setup-notes -->
Reusable Markdown content.
<!-- #endregion vpn-setup-notes -->

And includes like:

<!--@include: ../../reusables/larepass-vpn.md#vpn-setup-notes-->

Features

• Fold <!-- #region name --> / <!-- #endregion name --> blocks in Markdown.
• Show nested regions in the VS Code Outline panel.
• Show CodeLens actions on includes:
  • Go to region
  • Preview region
• Show CodeLens actions on region markers:
  • Copy include
• Diagnose common issues:
  • unclosed regions
  • unexpected #endregion
  • mismatched region names
  • duplicate region names in a file
  • line-range includes such as {10,20}
  • missing include target files
  • missing include target regions
  • optionally unused regions

Local development

npm install
npm run compile

Press F5 in VS Code to launch an Extension Development Host.

Build a VSIX

npm run package

This creates a file like markdown-region-navigator-0.1.0.vsix.

Install from a GitHub release

Download the latest .vsix file from the GitHub Releases page, then install it in VS Code with Extensions: Install from VSIX....

Install it from VS Code with Extensions: Install from VSIX....

If the code CLI is available, you can also run:

code --install-extension markdown-region-navigator-0.1.0.vsix