CodeMargin - 你的代码笔记本

CodeMargin 是一款为开发者打造的 VS Code 插件，让你在阅读代码时能像在纸质书上做笔记一样，随时随地记录感悟、逻辑分析或待办事项。

✨ 核心特性

• 代码内联笔记：选中代码片段或针对整个文件添加 Markdown 格式的笔记。
• 视觉锚点：在编辑器中通过下划线、背景色等多种样式标记已记录笔记的代码段。
• 侧边栏概览：通过专用的 Webview 面板统一浏览、搜索和管理所有笔记。
• 本地存储：笔记以 Markdown 文件形式存储在你指定的本地目录，方便备份、Git 同步或使用 Obsidian 等工具二次编辑。
• 智能关联：笔记自动关联当前工作区、文件路径及代码行号。

🚀 快速开始

1. 设置存储目录：安装后，首先运行命令 CodeMargin: 选择笔记存储目录 或在设置中配置 codemargin.storageDir。
2. 添加笔记：
   • 选中一段代码 -> 右键选择 笔记：添加。
   • 在文件空白处 -> 右键选择 笔记：添加（当前文件）。
3. 查看与管理：点击侧边栏的 CodeMargin 图标，即可看到当前文件的笔记以及全局搜索入口。

⚙️ 扩展设置

本插件提供以下配置项：

• codemargin.storageDir: 笔记存储的根目录。
• codemargin.decorations.enabled: 是否在编辑器中显示笔记高亮标记。
• codemargin.decorations.style: 标记样式（underline, background, wavy-underline 等）。
• codemargin.decorations.color: 标记的颜色。

📂 存储格式

笔记存储在 storageDir 下，按工作区名称分目录存放。

• notes/*.md: 每一条笔记都是一个独立的 Markdown 文件。
• index.jsonl: 自动生成的索引文件，确保极致的检索速度。

Enjoy coding with context!