obsidian-plugin/hanser0521_Wave-TOC
1
0
Fork 0
mirror of https://github.com/hanser0521/Wave-TOC.git synced 2026-07-22 08:31:52 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
No description
57 commits 1 branch 6 tags 4.8 MiB
TypeScript 83.8%
CSS 14.5%
JavaScript 1.7%
Find a file
Hanser0521 59bb6c86ae
Update README.md
2026-07-17 21:30:39 +08:00
.github/workflows Remove incompatible provenance attestation 2026-07-17 17:36:47 +08:00
assets Add Wave TOC demo animation 2026-07-17 20:24:13 +08:00
.gitignore Add .gitignore to exclude build and environment files 2026-07-16 16:23:01 +08:00
CHANGELOG.md Document 1.0.5 review retry 2026-07-17 17:41:43 +08:00
esbuild.config.mjs Add esbuild configuration for bundling TypeScript 2026-07-16 16:26:43 +08:00
LICENSE Add MIT license 2026-07-16 17:12:49 +08:00
main.ts Refresh release asset digest 2026-07-17 17:41:31 +08:00
manifest.json Bump marketplace review release to 1.0.5 2026-07-17 17:41:15 +08:00
package-lock.json Lock 1.0.5 package metadata 2026-07-17 17:41:26 +08:00
package.json Align package version with 1.0.5 2026-07-17 17:41:20 +08:00
README.md Update README.md 2026-07-17 21:30:39 +08:00
README.zh-CN.md Update README.zh-CN.md 2026-07-17 21:29:28 +08:00
styles.css Refresh stylesheet asset digest 2026-07-17 17:41:37 +08:00
tsconfig.json Add tsconfig.json with compiler options 2026-07-16 16:28:03 +08:00

README.md

Wave TOC

English | 简体中文

Wave TOC turns the active note's outline into a compact floating navigation rail beside the document. Move across the ticks to preview headings and nearby content, follow the current section while scrolling, or jump directly to any heading—without giving up sidebar space.

Designed for long notes, it stays accurate in both Editing and Reading views and keeps the interaction calm: scrolling changes only the active color, while the smooth wave animation appears on hover.

Wave TOC in action

Highlights

  • Floating H1–H3 rail inside the active note
  • Smooth multi-tick hover wave and heading bubble
  • Optional hover-card previews: title only, first paragraph, or a locally extracted section summary
  • Current section indicated by color without changing tick length
  • Configurable navigation: follow the pointer or jump only after click
  • Configurable section tracking: follow the scrolling viewport or use the cursor click behavior
  • Localized settings with Chinese and English interfaces
  • Accurate heading navigation in Editing and Reading views
  • Automatic updates when headings change
  • Configurable side, heading depth, and rail height

Build

npm install
npm run build

Copy manifest.json, main.js, and styles.css into:

<Vault>/.obsidian/plugins/wave-toc/

Then reload Obsidian and enable Wave TOC under Community plugins. Hover-card content, navigation, and scroll-tracking behavior can be changed under Settings → Wave TOC. The settings interface is available in Chinese and English.

Privacy

Wave TOC works locally inside Obsidian. It does not send note content to external services, collect telemetry, show ads, or require an account.

Acknowledgements

Functional research for this independent implementation included Next TOC and Floating TOC. No source code or assets from those projects are included in Wave TOC.

Wave TOC is an independent project and is not affiliated with or endorsed by OpenAI.

License

MIT © 2026 Hanser