mirror of
https://github.com/kilng235/article-annotator-plugin.git
synced 2026-07-22 18:00:38 +00:00
No description
- Fix command palette labels (remove "手机端:" prefix) - Correct README inconsistencies with actual plugin behavior - Restore manifest.json to repo |
||
|---|---|---|
| .gitignore | ||
| CHANGELOG.md | ||
| LICENSE | ||
| main.js | ||
| manifest.json | ||
| README.md | ||
| styles.css | ||
Article Annotator
Obsidian 插件:文章批注 —— 像 Microsoft Word 一样高亮文本并添加批注
💖 如果觉得这个插件好用,请给个 Star 支持一下!
功能
- 文本高亮 + 批注:在 Markdown 编辑器中高亮选中文字,添加类似 Word 的批注
- 即点即编:单击批注卡片定位到正文,双击原地进入编辑,blur 自动保存,Esc 取消
- 笔记本内页风格:批注卡片采用横线纸面、装订孔、页边距竖线和色条标记,视觉统一为纸质笔记质感
- 侧边栏管理:在侧边栏面板中查看所有批注,支持定位、删除、导出
- 批注卡片拖拽排序:在侧边栏中自由拖拽调整批注顺序
- 批注分组管理:支持选择多个批注创建分组,拖拽归类,折叠/展开,重命名、取消分组
- 多端支持:支持 电脑(Desktop) / iPad / 手机(Android) 三端同步
- 批注同步文件:
article-annotator/annotations.json - 安装后不会立刻创建;首次开始批注或从旧版本迁移数据时会自动创建
- 批注同步文件:
- 中英双语:支持中英文界面切换
- 6 色高亮:暖黄、琥珀、橙色、赤红、紫色、青色,支持自定义颜色
- 快捷键支持:高亮、新建批注均可绑定快捷键
- 移动端适配:支持 Android 和 iPad 触摸操作
🔤 Features (English)
- Text Highlight + Annotations: Highlight selected text in Markdown editor and add Word-like comments
- Click-to-Edit: Single-click card to locate in text, double-click to edit in place — blur auto-saves, Esc cancels
- Notebook Style: Cards feature ruled lines, punch holes, margin line, and color stripe for a paper notebook aesthetic
- Sidebar Management: View all annotations in the sidebar panel with locate, delete, and export support
- Drag-and-Drop Cards: Reorder annotation cards freely in the sidebar
- Annotation Groups: Create groups from multiple annotations, drag to organize, collapse/expand, rename, ungroup
- Multi-Device Sync: Sync annotations across Desktop / iPad / Android
- Synced annotation file:
article-annotator/annotations.json - Created automatically when you add your first annotation or when legacy data is migrated
- Synced annotation file:
- Bilingual: Switch between Chinese and English interfaces
- 6 Highlight Colors: Warm Yellow, Amber, Orange, Red, Purple, Cyan — customizable
- Keyboard Shortcuts: Highlight and new annotation can be bound to shortcuts
- Mobile Support: Touch-friendly on Android and iPad
安装
Obsidian 社区插件市场(推荐)
- 打开 Obsidian → 设置 → 社区插件 → 浏览
- 搜索
Article Annotator - 点击安装并启用
手动安装
- 从 Releases 下载最新版本的
main.js、manifest.json、styles.css - 在 Obsidian vault 的
.obsidian/plugins/目录下新建文件夹article-annotator - 将三个文件放入该文件夹
- 重启 Obsidian,在设置 → 社区插件中启用
🔤 Installation (English)
Community Plugin Store (Recommended)
- Open Obsidian → Settings → Community Plugins → Browse
- Search
Article Annotator - Click Install and Enable
Manual Install
- Download the latest
main.js,manifest.json,styles.cssfrom Releases - Create a folder
article-annotatorunder.obsidian/plugins/in your vault - Place the three files in that folder
- Restart Obsidian and enable it in Settings → Community Plugins
使用说明
高亮文本
- 在 编辑模式 下选中文字
- 使用命令
文章批注:高亮当前选中(默认颜色)(或绑定快捷键) - 高亮颜色在设置中可自定义
添加批注
- 选中文字后,右键选择 高亮 或 添加批注(也可使用命令面板)
- 输入批注内容后自动保存
- 批注卡片支持拖拽排序
管理批注
- 编辑:双击批注卡片原地编辑,无需弹窗
- 定位:单击批注卡片定位到正文对应位置
- 删除:点击删除按钮(全局删除有二次确认)
- 清空:可一键清空所有批注
- 导出:支持导出为 Markdown 格式
阅读模式
⚠️ 阅读模式当前不显示批注高亮,请在编辑模式下查看。
🔤 Usage (English)
Highlight Text
- Select text in Editing mode
- Use command
Article Annotator: Highlight current selection (default color)(or bind a shortcut) - Highlight color is customizable in settings
Add Annotation
- Select text, then right-click to choose Highlight or Add Note (or use command palette)
- Annotation content is saved automatically
- Annotation cards support drag-and-drop reordering
Manage Annotations
- Edit: Double-click annotation card to edit in place, no modal needed
- Locate: Single-click annotation card to jump to its position in the text
- Delete: Click delete button (global delete has double confirmation)
- Clear All: One-click to clear all annotations
- Export: Export as Markdown
Reading Mode
⚠️ Annotations are not visible in Reading mode. Please switch to Editing mode to view highlights.
设置
| 设置项 | 说明 |
|---|---|
| 默认高亮颜色 | 选择新批注的默认颜色 |
| 语言 | 中文 / English 界面切换 |
| 高亮颜色列表 | 6 种颜色可自定义 |
| 快捷键 | 在 Obsidian 设置 → 快捷键中绑定 |
🔤 Settings (English)
| Setting | Description |
|---|---|
| Default Color | Choose default color for new annotations |
| Language | Switch between Chinese and English interfaces |
| Highlight Colors | 6 customizable colors |
| Shortcuts | Bind in Obsidian Settings → Hotkeys |
版本历史
详见 CHANGELOG
🔤 Changelog (English)
See CHANGELOG
注意事项
- 所有批注数据独立保存于知识库根目录下的
article-annotator/annotations.json,不修改原文文件 - 安装插件后不会立刻创建该文件;首次开始批注或旧版数据迁移时会自动创建
- 旧版本保存在
.obsidian/plugins/article-annotator/data.json的批注会自动迁移到新的同步文件 - 阅读模式下高亮不显示,仅编辑模式可见
🔤 Notes (English)
- All annotation data is stored independently in
article-annotator/annotations.jsonat the root of your vault, without modifying original files - This file is not created immediately on install; it is created automatically when you add your first annotation or when legacy data is migrated
- Existing annotations stored in
.obsidian/plugins/article-annotator/data.jsonare migrated automatically to the new synced file - Highlights are not visible in Reading mode, only in Editing mode
许可
MIT License
🔤 License (English)
MIT License