Welcome to NVBar! 🚀
NVBar is a simple, fast note-taking sidebar for VS Code inspired by nvALT.
Quick Start
Creating Notes
- Type a filename in the search box and press Enter to create a new note
- Files are automatically saved with the
.md extension
Searching Notes
- Start typing in the search box to filter files by name
- Use the Search button (magnifying glass) in the toolbar for full-text content search
- Press Escape to clear the search
Keyboard Shortcuts
- Cmd+L (Ctrl+L on Windows/Linux): Focus search box
- Cmd+T: Edit tags for selected file
- Cmd+P: Toggle pin for selected file
- Cmd+R: Rename selected file
- Cmd+Backspace: Delete selected file
- Arrow Down from search box: Move to first file
- Arrow Up/Down: Navigate through files
- Enter: Open selected file or create new file
- Shift+Enter: Search file contents (one-time content search)
- Escape: Clear search and return to search box
Sorting
Use the toolbar buttons to sort your notes:
- A-Z icon: Sort by filename (toggle A-Z/Z-A)
- Calendar icon: Sort by modification date (toggle Newest/Oldest)
The status bar (bottom-right) shows your current sort setting.
Configuration
NVBar stores settings in .nvbar.json in your workspace folder:
sortBy: "alphabetical", "modificationDate", or "creationDate"sortDirection: "asc" or "desc"showFileExtensions: true or falsesearchDebounce: delay in milliseconds (default: 300)shortcuts: customizable keyboard shortcuts (see defaults above)
Tips
- NVBar automatically watches for file changes and updates the list
- All markdown files in your workspace folder are shown
- Preview lines show the first 2 lines of content with markdown stripped
- Long filenames are truncated with ellipsis
Learn More
Happy note-taking! ✍️
Requirements
License
MIT
| |
