README file from
GithubPure Footnote (脚注 & 注记大纲)
适用于 Obsidian 的脚注与行内注记大纲。支持在侧边栏管理、快速跳转及直接编辑文档中的所有脚注与自定义悬浮注记。
插件还在测试当中,如果有 bug 或错误,加群讨论。 QQ 交流群: 1094620986
English Version
功能特点
- 脚注与悬浮注记双重支持:在侧边栏统一展示并管理 Markdown 标准脚注 [^1] 和自定义行内注记 [字词]{释义}。
- 光标跟随与双向跳转:根据当前编辑器光标位置高亮侧边栏中对应的项;点击侧边栏条目即可定位到文档对应位置。
- 便捷可视化编辑:内置可拖拽的编辑弹窗,无需翻找文档底部,直接在面板右键或点击即可修改脚注序号与内容。
- 可选的脚注美化:一键开启美化样式,在实时预览/阅读模式下为脚注附带提示图标(💬),隐藏繁杂的悬浮窗标题,并优化悬浮字体排版。
- 右键快捷菜单:支持按数字/字母排序切换、随时一键开关美化样式等。
安装方法
社区插件安装(推荐)
待插件上架后,可在 Obsidian 内直接安装:
- 打开 Obsidian 设置 > 社区插件。
- 点击 浏览 并搜索 Pure Footnote View。
- 点击 安装,随后启用。
手动安装
- 从 Releases 页面下载最新版发布包(main.js, manifest.json, styles.css)。
- 在您的库中创建插件目录:<库路径>/.obsidian/plugins/pure-footnote-view/。
- 将下载的文件放入该目录中。
- 打开 Obsidian 设置 > 社区插件,开启该插件。
使用说明
- 点击 Obsidian 左侧工具栏的数字列表图标(list-ordered)打开“脚注 & 注记大纲”面板。
- 在文档中编写标准脚注,或编写形如 [标记内容]{悬浮显示内容} 的自定义注记。
- 在侧边栏大纲面板中,点击条目实现文档跳转,或右键条目进行编辑、列表排序和样式美化配置。
English
A convenient sidebar outline for footnotes and inline hover notes in Obsidian. Easily track, jump to, and edit your notes in real-time.
Features
- Bilingual Support for Footnotes & Hover Notes: Displays traditional markdown footnotes [^1] alongside custom inline hover notes [key]{content} in a dedicated sidebar.
- Cursor Tracking & Interactive Jump: Highlights the footnote closest to your current cursor and allows clicking any item in the outline to jump to its location in the editor.
- Inline Editing Modal: A draggable popup window that allows you to rename keys or modify footnote content on the fly without disrupting your reading or writing flow.
- Visual Enhancements (Beautify Style): An optional toggle to append a comment emoji (💬) to footnote markers, hide cluttering titlebars, and improve hover popover readability.
- Sorting & Context Menu: Quickly switch between document order and alphanumeric key-sorting directly from the right-click menu.
Installation
Community Plugins (Recommended)
Once this plugin is approved, you can install it directly from Obsidian:
- Open Obsidian Settings > Community plugins.
- Click Browse and search for Pure Footnote View.
- Click Install, then Enable.
Manual Installation
- Download the latest release (main.js, manifest.json, styles.css) from the Releases page.
- Create a folder named pure-footnote-view under your vault's plugin directory: /.obsidian/plugins/pure-footnote-view/.
- Copy the downloaded files into that folder.
- Go to Obsidian Settings > Community plugins and enable the plugin.
Usage
- Click the list icon (list-ordered) in the left ribbon to open the Footnote & Hover Note Outline sidebar.
- Write standard markdown footnotes (e.g., [^1]) or custom inline hover notes (e.g., [text]{note content}) in your active editor.
- Use the outline list to review all annotations. Click an item to navigate to its source, or right-click to edit content, sort the list, and toggle the beautification stylesheet.