Invoke Add note at current position from the command palette or context menu.
You can see the note you wrote as hover text.
Notes are saved by default in $PROJECT_ROOT/.vscode/.linenoteplus like .vscode/.linenoteplus/<short-uid>.md.
Overview
Edit/open or remove note via Cmd + Click
Markdown note previews on hover
Right-click to add note to line
Right-click to reveal notated line
Delete a note marker by manually deleting in text editor
Add a note marker by manually typing in text editor
Custom note names
Command to add note
Command to edit/open note
Command to remove note
Command to reveal notated line
Notes move with code changes
Notes can be moved between files
Notes are not affected by refactors
Add notes within your notes
Customize notes directory, note marker background color, and annoted line ruler color
Configure to delete orphaned notes on-save, on-inteveral, on-save-and-on-interval, or never
API
Commands
linenoteplus.addNote: Add note at current position (Annotate Line)
linenoteplus.openNote: Edit note at current position (Open Note)
linenoteplus.revealLine: Reveal line in notated file (Show Note Marker)
linenoteplus.removeNote: Remove note at current position (Delete Note)
Configuration
linenoteplus.cleanUpOrphanedNotesInterval: Interval at which to clean up unused notes in the background in ms. Only applies if cleanUpOrphanedNotes is set to on-interval or on-save-and-on-interval. Default: 60000 (60s). For performance, a larger value is recommended.
linenoteplus.cleanUpOrphanedNotes: Defines the cleanup behavior for orphaned notes. It can be set to on-save, on-interval, on-save-and-on-interval, or never. Default: on-save-and-on-internal. Note that when using on-save or on-save-and-on-interval, if you delete a note marker and save the file then your note file will also be deleted.
linenoteplus.includePaths: Specifies file pattern globs to scan for note markers. Directories that don't match these patterns will be ignored.
linenoteplus.gutterIconPath: File path of the icon to be displayed in gutter.
linenoteplus.lineColor: Sets the background color for inline note markers (Name, HEX, or RGB).
linenoteplus.rulerColor: Sets the ruler color for notated lines (Name, HEX, or RGB).
linenoteplus.showGutterIcon: Whether to display the gutter icon in the gutter for a noted line. Default: true.
Demos
Adding a note
Custom note title
Notes move with code changes
Notes can be moved across files
Reveal notated line command
Refactor does not affect notes
Acknowledgements
Line Note Plus is a fork of Line Note by tkrkt. This library's design
was also informed by Marginalia by indiejames.