JetDocs Mode
JetBrains-style rendered documentation, in place, in VS Code.
JetDocs Mode hides the structural markers of JSDoc / DocBlock comments (/**, *, */)
and draws a subtle vertical left border down the block — so documentation reads as prose
while you browse, and reverts to raw markup the moment your cursor enters it.
Features
- Reader mode. Leading asterisks collapse to zero width; the block keeps a JetBrains-style
vertical border and muted italic typography.
- Auto-unfold on edit. Raw syntax reappears instantly when any cursor enters the block.
Multi-cursor aware — one cursor inside is enough.
- No webviews, no panels. Built entirely on the
TextEditorDecoration API.
- Theme-aware. Border color defaults to the theme's comment color, and every visual is
overridable in settings.
Supported languages
Any /** ... */ language: TypeScript, TSX, JavaScript, JSX, PHP, Java, C#, C, C++,
Kotlin, Scala, Dart, Go, Rust, Swift, Groovy, CSS, SCSS and Less.
Single-line // comments are deliberately untouched, and PHP additionally honours
# line comments so their contents are never mistaken for documentation.
Commands
| Command |
Description |
JetDocs Mode: Toggle Reader Mode |
Turns rendering on/off for the current session |
Settings
| Setting |
Default |
Description |
jetdocsMode.enabled |
true |
Enable rendering |
jetdocsMode.hideMarkers |
true |
Collapse /**, *, */ while the cursor is outside |
jetdocsMode.borderColor |
"" |
Border color; empty follows the theme |
jetdocsMode.borderWidth |
"2px" |
Border width |
jetdocsMode.textColor |
"" |
Documentation text color; empty keeps theme tokens |
jetdocsMode.fontStyle |
"italic" |
normal or italic |
jetdocsMode.fontWeight |
"normal" |
CSS font weight |
jetdocsMode.languages |
see package.json |
Language IDs where the extension is active |
jetdocsMode.debounceDelay |
120 |
Milliseconds to wait after an edit before re-parsing |
jetdocsMode.maxFileSize |
1000000 |
Skip files larger than this many characters (0 disables) |
jetdocsMode.statusBar |
true |
Show a status bar item reflecting the toggle state |
Development
npm install
npm run watch # incremental compile
npm run typecheck # tsc --noEmit
npm run lint
npm test # compiles, lints, then runs the suite in a VS Code host
Press F5 in VS Code to launch an Extension Development Host.
License
MIT
