Skip to content

huidev2025/embedded-notes

Repository files navigation

Embedded Notes Plugin

在 Obsidian 笔记的正文中嵌入行间批注的插件。

✨ 功能特性

📝 基础功能

  • 行间批注:在正文中插入批注,不影响正文阅读
  • 自定义标记:可自定义批注的开始/结束标记
  • 批注结束符:批注末尾显示自定义符号

🎨 样式定制

  • 字体大小:调整批注相对于正文的大小
  • 颜色配置:自定义批注文字颜色
  • 边框样式:自定义左侧边框颜色和宽度
  • 尺寸控制:设置批注的最大宽度和最小高度

🌈 颜色标记

  • 三种颜色:支持红、蓝、绿三种颜色标记
  • 自定义标记:可自定义每种颜色的标记符号
  • 自定义颜色值:可自定义每种颜色的具体色值

🖼️ 图片支持

  • 批注中插入图片:支持在批注中使用 Obsidian 的图片链接
  • 图片大小控制:可设置图片的最大宽度
  • 启用/禁用:可选择是否在批注中显示图片

👁️ 显示控制

  • 快捷键切换:快速切换批注显示/隐藏
  • 配置页开关:在设置页面控制批注显示
  • 状态持久化:显示状态在重启后保持

📦 安装

方法1:通过 Obsidian 社区插件(推荐)

  1. 打开 Obsidian 设置
  2. 进入"第三方插件"
  3. 关闭"安全模式"
  4. 点击"浏览",搜索 "Embedded Notes"
  5. 点击"安装"

方法2:手动安装

  1. 下载最新的 Release
  2. 解压到 <vault>/.obsidian/plugins/embedded-notes/
  3. 重启 Obsidian
  4. 在设置中启用插件

📖 使用方法

基础语法

正文内容-c这是一条批注c-继续正文

效果:

  • 编辑模式(实时预览):批注以小字显示在正文旁边
  • 阅读模式:批注以小字显示在正文旁边
  • 源码模式:显示原始标记

1. 换行

在批注中使用 -br- 强制换行:

-c第一行-br-第二行c-

2. 颜色标记

在批注中使用颜色标记:

-c这是-r红色文字r-,这是-b蓝色文字b-,这是-g绿色文字g-c-

3. 插入图片

在批注中插入图片:

-c这是批注文字 ![[image.png]] 继续批注c-

指定图片宽度:

-c这是批注文字 ![[image.png|100]] 继续批注c-

4. 组合使用

正文-c这是批注-br--r重要提示r- ![[icon.png|50]]c-继续正文

⚙️ 配置选项

1. 批注标记

  • 批注开始标记:默认 -c
  • 批注结束标记:默认 c-
  • 批注结束符号:默认 ||
  • 换行标记:默认 -br-

2. 颜色标记

  • 红色标记:开始 -r,结束 r-,颜色 #ff4757
  • 蓝色标记:开始 -b,结束 b-,颜色 #1e90ff
  • 绿色标记:开始 -g,结束 g-,颜色 #2ed573

3. 批注样式

  • 字体大小:默认 0.7(70% 正文大小)
  • 行高:默认 1.1
  • 文字颜色:默认 #4a9eff
  • 左边框颜色:默认 #ddd
  • 左边框宽度:默认 2px
  • 最大宽度:默认 780px
  • 最小高度:默认 2em

4. 图片设置

  • 启用图片:默认启用
  • 图片最大宽度:默认 200px

5. 高级设置

  • 调试模式:启用后在控制台输出详细日志
  • 显示批注:控制批注是否显示

⌨️ 快捷键

  • 切换批注显示/隐藏Ctrl/Cmd+Shift+H

🎯 使用场景

1. 读书笔记

原文:人生的意义在于追求幸福。-c这里的"幸福"是指什么?
作者在后文有解释。c-

原文:幸福是一种主观感受。-c-r重要观点r-c-

2. 学习笔记

定义:函数是一种映射关系。-c数学定义:f: X → Y-br-
每个 x ∈ X 都有唯一的 y ∈ Y 与之对应c-

3. 代码注释

```python
def calculate(x):
    return x * 2  # -c这里可以优化-br-使用位运算 x << 1c-

### 4. 翻译对照
```markdown
The quick brown fox jumps over the lazy dog.
-c翻译:敏捷的棕色狐狸跳过懒狗。-br-
-b注意c-:这是一个包含所有字母的句子。c-

🔄 版本历史

1. v1.1.1 (2025-12-08)

  • 🐛 修复图片尺寸逻辑
  • 🐛 修复阅读模式短批注对齐问题
  • 🌍 完整UI英文化
  • 🔧 优化调试日志

2. v1.1.0 (2025-12-07)

  • ✨ 完整的配置系统
  • ✨ 显示/隐藏批注功能
  • ✨ 图片支持
  • ✨ 颜色标记
  • ✨ 完整的配置页面
  • 🐛 修复各种 bug

2. v1.0.1

  • 🐛 修复编辑模式图片显示问题
  • 🐛 修复光标移动时的渲染问题

3. v1.0.0

  • 🎉 初始版本
  • ✨ 基础批注功能
  • ✨ 编辑模式和阅读模式支持

📝 许可证

MIT License

🙏 致谢

感谢 Obsidian 社区的支持和反馈。

📧 联系方式


如果觉得这个插件有用,请给个 ⭐️ Star!

📜 许可证

本项目采用 MIT 许可证 - 详见 LICENSE 文件

示例截图

  1. 示例1
  2. 示例2

About

Embed inline annotations within your notes.

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors