Note with VS

A Markdown note manager for VS Code with local file support and reminder support.

Features in Action

Installation

Configure Folders

Sorting files

Copy Note

Create/Use Template

Add Note and Reminder

Features

• Multi-Folder Support: Configure multiple base directories for your notes and manage them independently in a unified workspace view.
• Recursive Folder Scanning: Organize your notes using nested subfolders, all scanned up to a configurable depth (default 5).
• Todo List & Reminders: Dedicated view for task-based reminders (- [ ] @due(...)) and a "Todo list" for plain tasks without due dates.
• Git Sync: Built-in Git synchronization with visual status indicators for each note.
• Template System: Define and use reusable content snippets across all your note folders.
• Local Note Management: Store your notes as standard Markdown files in a local folder of your choice.
• Labels as Folders: Organize your notes using subfolders, which act as "Labels".
• Reminders & Follow-ups: Add reminders to your notes using a simple syntax (- [ ] Task @due(YYYY-MM-DD)).
• Dedicated Side Bar: Access your notes and reminders easily from the custom Side Bar view.
• Cross-Platform: Works seamlessly on Windows, Linux, and macOS.

Getting Started

1. Install the extension.
2. Default Storage: By default, notes are stored in Documents/NoteForVS.
3. Custom Storage: You can configure a custom folder in Settings:
   • Open VS Code Settings (Ctrl+,).
   • Search for notewithvs.notesFolderPath.
   • Enter the absolute path to your desired folder.
4. Additional Folders: Add more folders in notewithvs.notesFolders to manage multiple project notes separately.
5. The "Note with VS" icon will appear in the Activity Bar. Click it to start creating notes!

Reminder Syntax

To create a reminder, simply add a task list item in any note with the @due(date) tag:

- [ ] Call Alice about the project @due(2023-12-01)
- [ ] Review PR [#123](https://github.com/sarivoli/vscodenote/issues/123) @due(2023-11-25)

The extension will automatically detect these and list them in the "Reminders" view, grouped by:

• Overdue
• Today
• Upcoming
• Todo list (for items without a due date)

Managing Notes

Creating Notes

You can create a new note by clicking the + (Create Note) button in the "Notes" view title bar or running the command Note with VS: Create Note.

Context-Aware Creation: When you create a note while a folder or note is selected, the new note will be created in that specific location.

Creating Labels (Folders)

You can create a new label (folder) by clicking the folder icon in the view title bar or running Note with VS: Create Label.

Deleting & Renaming

Right-click on any note or label to access deletion, renaming, and moving options.

Copy to Clipboard

Run Note with VS: Copy Notes to capture the content of any active editor into a local Clipboard folder.

Git Sync

You can sync your notes to a remote Git repository directly from VS Code using Note with VS: Save Notes (Git Sync).

• Status Indicators: Yellow (Modified), Green (Added/Untracked), Red (Deleted), Warning (Conflict).
• Multi-Folder Sync: If multiple folders are configured, the extension will sync all of them in parallel.

Template Syntax

Define templates using HTML comments:

<!-- @template(Daily Standup) -->
### Daily Standup
- **Yesterday**: 
- **Today**: 
- **Blockers**: 
<!-- @endtemplate -->

Templates are listed in the "Templates" view. Click to copy content or use the context menu to hide/rename templates.

Extension Settings

• notewithvs.notesFolderPath: Path to your primary notes folder.
• notewithvs.notesFolders: Array of additional note folders { "name": "Work", "path": "/path/to/work" }.
• notewithvs.maxFolderDepth: Maximum nesting depth for scanning (default 5).

Release Notes

1.2.1

• Configuration Migration: Automatically converts legacy folder settings to the new structured format.
• Fixes: General bug fixes, case-insensitive file scanning, and performance improvements.

1.2.0

• Multi-Folder Support: You can now configure multiple note folders in settings. Each folder appears with its own name and independent operations.
• Todo List: Tasks marked with - [ ] without an @due date are now automatically listed in a new "Todo list" section within the Reminders view.
• Deep Scanning: Reminders and templates are now scanned recursively across all subfolders up to the configured maxFolderDepth.
• Dynamic Header: Added a professional header in the sidebar displaying extension version and build info.
• Unified Sync: "Save Notes" now syncs all configured note directories in parallel.

1.1.0

• Folder Management: Added support for recursive folder scanning.
• Move Notes: Support for moving notes between folders.
• Folder Depth Limit: Introduced maxFolderDepth setting.

1.0.1 - 0.0.1

(See full history in PROJECT.md)