README file from
Github插件说明书
为 Obsidian 已安装的第三方社区插件提供官方说明与中文注释,帮助快速了解每个插件的用途。侧边栏可编辑「我的说明」,弹窗仅供只读查阅。
功能
- 侧边栏一览 — 官方原文(只读)+ 连写中文注释:
英文原文(注释:中文翻译) - 我的说明 — 侧边栏可编辑个人备注,修改不影响上方官方原文
- 弹窗模式 — 仅官方说明只读查阅,卡片右上角可打开插件设置
- 自动翻译 — 从 Obsidian 社区插件库拉取官方英文说明并译为简体中文(需联网)
- 搜索 — 按插件名、官方说明、个人说明筛选
安装
从社区插件市场(审核通过后)
- 打开 设置 → 社区插件 → 浏览
- 搜索 Community Helper(社区显示名;插件内界面为中文)
- 安装并启用
手动安装
- 从 Releases 下载
main.js、manifest.json、styles.css - 复制到
你的库/.obsidian/plugins/plugin-helper/ - 在 设置 → 社区插件 中启用 Community Helper
使用
| 入口 | 操作 |
|---|---|
| 左侧栏 📖 图标 | 打开侧边栏面板 |
| 命令面板 | 「打开插件说明书(侧边栏)」或「打开插件说明书(弹窗)」 |
| 设置页 | 插件说明书 — 刷新翻译、打开侧边栏或弹窗 |
- 侧边栏:官方说明 + 可编辑「我的说明」
- 弹窗:仅官方说明(只读);编辑说明请用侧边栏
点击 刷新翻译 可拉取最新社区说明并自动翻译(已手动修改的「我的说明」不会被覆盖)。
开发
npm install
npm run dev # 监听构建
npm run build # 生产构建
将插件目录放入 .obsidian/plugins/plugin-helper/ 后重载 Obsidian 即可调试。
环境要求
- Obsidian 1.5.0 及以上
- 首次拉取说明与刷新翻译需要网络