Yi Notes - Project Specific Notes for VS Code

Yi Notes is a simple Visual Studio Code extension for taking project-specific notes directly within your workspace. Keep your thoughts, reminders, and documentation snippets organized and accessible without leaving your editor.

Features

• Project-Specific: Notes are stored locally within your project's .vscode/yi-notes folder.
• Activity Bar Integration: Easy access via a dedicated icon in the VS Code Activity Bar.
• Tree View: Organize notes and folders hierarchically within the dedicated Yi Notes view.
• Markdown Support: Write notes using standard Markdown syntax.
• Live Preview: Single-click a note to view the rendered Markdown preview in a separate tab.
• Quick Editing: Double-click a note (or use the right-click context menu) to open it directly in the VS Code editor.
• Local Storage Only: Notes are designed to stay local to your development environment and are not intended for version control by default.

Requirements

• Visual Studio Code version 1.80.0 or higher.

Installation

Marketplace (Recommended - Once Published)

(Coming Soon! Once published, you will be able to install Yi Notes directly from the Visual Studio Code Marketplace.)

1. Open VS Code.
2. Go to the Extensions view (Ctrl+Shift+X or Cmd+Shift+X).
3. Search for Yi Notes (or the final published name).
4. Click Install.

Usage

1. Open the View: Click the Yi Notes icon in the Activity Bar (it looks like a small notepad).
2. Add Notes/Folders:
   • Use the + File (Add Note) and + Folder (Add Folder) icons located in the Yi Notes view's title bar.
   • Alternatively, right-click within the tree view (either on the empty space, a folder, or a file depending on the context menu) to add new notes or folders.
3. Preview Note: Single-click on any .md note file listed in the tree view. This will open a rendered Markdown preview in a new tab.
4. Edit Note: Double-click on a .md note file in the tree view, or right-click on it and select "Edit Note". This will open the raw Markdown file in a standard VS Code editor tab.
5. Delete: Right-click on any note or folder in the tree view and select "Delete". You will be prompted for confirmation before the item is removed from the filesystem.
6. Storage Location: All notes and folders created by this extension reside within the .vscode/yi-notes/ directory at the root of your currently open workspace folder.

IMPORTANT: Ignoring Notes in Git

Since notes are stored within your project structure (in .vscode/yi-notes/), they might be picked up by Git if you haven't configured your .gitignore file appropriately. Because these notes are often intended for local reference (scratchpads, temporary reminders, local setup notes), it is highly recommended to add .vscode/yi-notes/ to your project's .gitignore file.

Add the following lines to your .gitignore:

# VS Code specific files (often includes .vscode/ already)
.vscode/*

# --- OR if you don't ignore all of .vscode ---

# Specifically ignore Yi Notes folder
.vscode/yi-notes/