Skip to content
| Marketplace
Sign in
Visual Studio Code>Other>CommentrayNew to Visual Studio Code? Get it now.
Commentray

Commentray

Dmitry L.

|
1 install
| (0) | Free
Side-by-side authoring for Commentray markdown tracks
Installation
Launch VS Code Quick Open (Ctrl+P), paste the following command, and press enter.
Copied to clipboard
More Info

Commentray for VS Code / Cursor

Side-by-side authoring for Commentray: out-of-file Markdown "commentary tracks" for any source file in your workspace.

Commands

  • Commentray: Open commentray beside source — opens (or creates) the commentray Markdown file that is paired with the active source file, side-by-side. While the pair is active, scroll sync keeps the two panes aligned: scrolling the source updates the commentray view, and scrolling the commentray snaps the source to the block you are reading. When you have blocks (metadata index + <!-- commentray:block id=… --> markers), sync prefers those anchors; otherwise it falls back to a simple proportional map.
  • Commentray: Add block from selection — appends a new block for the current selection (or current line) to the paired Markdown, updates .commentray/metadata/index.json, opens the pair, and selects the placeholder so you can type immediately. Default keybinding: Cmd+Alt+K (macOS) / Ctrl+Alt+K (Windows/Linux). Also available from the editor context menu under the same commands as Open commentray beside source.
  • Commentray: Open Markdown preview for commentray file — opens VS Code's built-in Markdown preview for the active .md file.
  • Commentray: Validate workspace metadata — runs the same validation as commentray validate and prints issues to the Commentray output channel.

Pairing convention

For a source file at repo-relative path src/foo.ts, the paired commentray file is .commentray/source/src/foo.ts.md. Missing files are created on demand (with a # Commentray placeholder) the first time you invoke Open commentray beside source.

Install

From a release .vsix:

code --install-extension commentray-vscode-<version>.vsix
# or: cursor --install-extension commentray-vscode-<version>.vsix

From the monorepo (builds + bundles + installs into your editor):

npm run extension:install

License

MPL-2.0

  • Contact us
  • Jobs
  • Privacy
  • Manage cookies
  • Terms of use
  • Trademarks
© 2026 Microsoft