Notes Comments
unlistedby HentaiMikuy
Highlight note text and attach comments or supplemental notes.
★ 1 starsUpdated 1mo agoMIT
Notes Comments
Obsidian 插件:在笔记中选中文字后添加勾划标记,并给标记绑定留言或 note 补充内容。
功能
- 选中文字后运行命令
添加标记留言,写入留言并生成标记。 - 同一个标记可以追加多条留言,留言会以对话线程的形式展示。
- 每条留言都支持独立编辑和删除;删除线程中的最后一条留言时,会同时移除正文标记。
- 标记样式可在插件设置中自定义。
- 内置预设:黄色荧光、蓝色批注、绿色虚线、玫瑰波浪。
- 留言展示方式可选:
- 鼠标移动到标记处时,底部中间向上滑出留言框。
- 鼠标移动到标记处时,在标记附近弹出留言框。
- 鼠标移动到标记处时,中间右侧滑出留言框。
- 留言窗口会限制最大高度,长留言和多条留言会在内容区滚动,不会无限撑高弹窗。
- 留言列表会突出显示备注人名称,并弱化时间信息,便于区分作者和正文。
- 支持命令
编辑光标处的标记留言和删除光标处的标记留言。 - 插件设置中可切换中文和英文界面,命令面板名称也会同步更新。
使用方式
- 在编辑器中选中需要标记的文字。
- 运行命令
添加标记留言,或在右键菜单中选择添加标记留言。 - 输入备注人和留言内容,保存后正文中会生成标记。
- 鼠标移动到标记处即可查看留言线程,并可继续追加、编辑或删除留言。
设置
留言展示方式:可选择底部中间滑出、标记处弹出或中间右侧滑出。语言:可切换中文和英文界面。默认备注人名称:新增或编辑留言时,如果备注人名称留空,就使用这个名称。默认标记样式:新增标记留言时默认使用的样式。样式预设:可以新增、删除、重置或调整标记样式,包括背景色、文字色、下划线颜色和下划线样式。
开发
npm install
npm run build
构建后会生成 main.js。作为 Obsidian 插件使用时,将 manifest.json、main.js 和 styles.css 放在 vault 的 .obsidian/plugins/obsidian-notes-comments/ 目录下并启用插件。
数据格式
插件会在 Markdown 中写入类似下面的 span,以便标记能随笔记内容保存:
<span class="onc-comment-mark" data-onc-id="..." data-onc-style="yellow-marker">被标记的文字</span>
其中 data-onc-id 是标记线程 ID。同一标记处的多条留言会共享这个线程 ID,留言内容、样式和展示方式保存在插件的 data.json 中。
版本记录
0.3.0
- 新增语言切换设置,支持中文和英文界面。
- 命令面板、右键菜单、设置页、留言弹窗、提示和确认框支持双语显示。
- 切换语言后会同步刷新命令面板名称和当前页面中已渲染标记的可访问性标签。
- 内置样式名称会跟随当前语言显示,同时保留用户自定义样式名称。
- 新增英文版 README 文档。
0.2.0
- 支持同一个标记处追加多条留言,并以对话线程形式展示。
- 支持对线程中的单条留言进行编辑和删除。
- 新增右侧中间滑出的留言展示方式。
- 优化长留言和多留言场景下的弹窗高度与滚动行为。
- 移除留言弹窗中重复显示的标记文字。
- 优化留言列表中的备注人名称显示,让作者和正文更容易区分。
- 优化设置页自定义下拉框样式,去除选项上的多余边框。
0.1.0
- 初始版本:支持选中文字添加标记留言、自定义标记样式、底部/标记处留言展示、编辑和删除留言。
For plugin developers
Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.