Line Note Plus is a VSCode extension to add markdown notes to your code that are visible when hovering over the noted line. Based on Line Note.
![basic-demo](https://private-user-images.githubusercontent.com/8428140/265300412-0ecb3057-2334-4413-b0aa-71889ae14a6b.png?jwt=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpc3MiOiJnaXRodWIuY29tIiwiYXVkIjoicmF3LmdpdGh1YnVzZXJjb250ZW50LmNvbSIsImtleSI6ImtleTUiLCJleHAiOjE3MjM5MTc0NTUsIm5iZiI6MTcyMzkxNzE1NSwicGF0aCI6Ii84NDI4MTQwLzI2NTMwMDQxMi0wZWNiMzA1Ny0yMzM0LTQ0MTMtYjBhYS03MTg4OWFlMTRhNmIucG5nP1gtQW16LUFsZ29yaXRobT1BV1M0LUhNQUMtU0hBMjU2JlgtQW16LUNyZWRlbnRpYWw9QUtJQVZDT0RZTFNBNTNQUUs0WkElMkYyMDI0MDgxNyUyRnVzLWVhc3QtMSUyRnMzJTJGYXdzNF9yZXF1ZXN0JlgtQW16LURhdGU9MjAyNDA4MTdUMTc1MjM1WiZYLUFtei1FeHBpcmVzPTMwMCZYLUFtei1TaWduYXR1cmU9ZTMyNjMyYmYzODE1ZDc5NDgxYWIyMDdmNjk5ZDNjZTRlMjg3Njc1YTg1NzJlOTNkMWZkOGIzMzZlM2U0OGIwNSZYLUFtei1TaWduZWRIZWFkZXJzPWhvc3QmYWN0b3JfaWQ9MCZrZXlfaWQ9MCZyZXBvX2lkPTAifQ.zPkMwOEOIOqyqLkiH9fc_j_RlCyXgClNVFQiyWZ6beM)
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
.
- 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
, ornever
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)
linenoteplus.cleanUpOrphanedNotesInterval
: Interval at which to clean up unused notes in the background in ms. Only applies ifcleanUpOrphanedNotes
is set toon-interval
oron-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 toon-save
,on-interval
,on-save-and-on-interval
, ornever
. Default:on-save-and-on-internal
. Note that when usingon-save
oron-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
.
Line Note Plus is a fork of Line Note by tkrkt. This library's design was also informed by Marginalia by indiejames.
PRs for bugfixes are welcome. I have no roadmap for new features, only improving stability.
- Gutter icon does not display.