📝 Your Notes
Your Notes is a VS Code extension that lets you manage notes without leaving your IDE. It uses Markdown as the default format to help you capture thoughts, code snippets, and documentation. Select content from the editor and save it as a note with one click, or add notes manually. You can also explore other users' notes from the Discover tab.
Your Notes 是一款 VS Code 扩展,让你无需离开 IDE 即可轻松管理笔记。默认使用 Markdown 格式,支持选中内容一键保存为笔记,也可以手动创建。你还可以通过 Discover 标签页浏览其他用户的笔记。
Features
- 🔐 Auth — JWT registration/login + GitHub OAuth, bcryptjs password hashing
- 📂 Categories — Color-coded organization for your notes
- 📝 Markdown rendering — Full GFM, Prism highlighting (100+ langs), GitHub theme, dark/light mode
- 🔍 Full-text search — Fast search via SQLite FTS5
- ⭐ Pin system — Pin notes for quick access in the Pinned tab
- 🌍 Discover — Browse public notes from other users, sorted by popularity
- 👥 Pin avatars — See who pinned a note with colored avatars
- 📄 VS Code editor integration — Edit in native editor with Ctrl+S auto-save
- 📋 YAML frontmatter — Edit category and metadata via frontmatter
- ⚡ Quick capture — Select text → Right-click → "Add Selection to Your Notes"
- 📤 Export — Export notes as Markdown files
功能特性
- 🔐 认证 — JWT 注册登录 + GitHub OAuth 一键登录,bcryptjs 密码加密
- 📂 分类 — 通过颜色标签对笔记进行分类整理
- 📝 Markdown 渲染 — 完整 GFM 支持,Prism 语法高亮(100+ 语言),GitHub 主题配色,自动深浅色模式
- 🔍 全文搜索 — 基于 SQLite FTS5 的高性能搜索
- ⭐ 收藏 — 收藏常用笔记到"已收藏"标签页快速访问
- 🌍 发现广场 — 浏览其他用户的公开笔记,按热度排序
- 👥 收藏头像 — 笔记详情页显示有哪些人收藏了它
- 📄 编辑器集成 — 在 VS Code 原生编辑器中编辑,Ctrl+S 自动保存
- 📋 YAML 元数据 — 通过 frontmatter 编辑分类和属性
- ⚡ 快速捕获 — 选中代码 → 右键 → "添加选中内容到笔记"
- 📤 导出 — 将笔记导出为 Markdown 文件
Quick Start
1. Install the extension
Install from VS Code Marketplace or:
code --install-extension buuug7.your-notes
2. Start using
- Click the your notes icon in the activity bar to open the notes panel
- Register a new account or Login to an existing one
- Use the three tabs: My Notes / Pinned / Discover
- Click "+ New Note" to create a note
- Select text in the editor → Right-click → "Add Selection to Your Notes"
| Tab |
Description |
| My Notes |
Your own notes, filterable by category |
| Pinned |
Notes you've pinned for quick access |
| Discover |
Browse public notes from other users |
Editing Notes
Click the + button to create a new note, or click an existing note to enter edit mode. When saving:
- Title — If empty, auto-extracted from the first line of content (first 50 characters)
- Category — Select from the dropdown
- If both title and content are empty, the Save button is disabled
In VS Code Editor
Click "Open in Editor" on a note detail page to open it as a Markdown file. The file includes YAML frontmatter:
---
category: 'Work'
---
# Note Title
Note content...
Press Ctrl+S to save. The extension automatically:
- Parses the
category field from frontmatter
- Matches it against existing categories (case-insensitive)
- Auto-creates a new category with a random color if no match is found
- Syncs title, content, and category back to the server
- First
# heading in the file
- First line of content (up to 50 chars, skipping
# * > - markers)
- Falls back to
Untitled
Notes
- Category name in frontmatter supports both quoted and unquoted:
category: Work or category: "Work"
- If the
category line or entire frontmatter is removed, the category is not modified
- Close and reopen the file to see the latest category name
Pinning Notes
- List view: Hover over a note card and click the pin icon
- Detail view: Click the pin icon in the header
- Pinned notes appear in the Pinned tab
- You can pin any note (your own or from Discover)
- Click the pin icon again to unpin
Searching
- My Notes: Type in the search box to full-text search your notes
- Discover: Type in the search box to search public notes from other users
- Use the category dropdown (My Notes tab) to filter by category
Commands
Your Notes: Add Selection to Your Notes — Save selected text as a new note
Your Notes: Open Notes Panel — Open the sidebar notes panel
Your Notes: Search Notes — Search across all your notes
Your Notes: Login to Your Notes — Authenticate with your account
Your Notes: Logout from Your Notes — Sign out
Requirements
- VS Code 1.85.0 or higher
- Node.js 18+
License
MIT