Skip to content

This is a plugin for obsidian which highlights a block of text or a word as you scroll down while reading.

License

Notifications You must be signed in to change notification settings

KarthikRaju391/obsidian-float

Repository files navigation

Obsidian Float

This plugin enhances Obsidian reading mode by animating highlighted content as it enters the viewport, so attention stays on important text while scrolling.

Features

  • Supports animated float effects for:
    • Highlights (==text== / <mark>)
    • Bold (**text** / <strong>)
    • Italic (*text* / <em>)
  • Per-tag controls:
    • Enable/disable animation per tag type
    • Independent scale amount per tag type
  • Global controls:
    • Animation duration
    • Background opacity dimming for non-highlighted content
    • Animate word only (instead of full container block)
    • Animate bold/italic inside highlight blocks
  • Scroll performance improvements:
    • Transform-only highlight transition for smoother scrolling
    • Ultra-smooth scrolling behaviour that temporarily removes shadow while actively scrolling, then restores it when scrolling stops

Usage

  1. Use Obsidian's built-in highlight syntax to mark text: ==your highlighted text==
  2. (Optional) In plugin settings, enable bold/italic animations and tune scale/duration
  3. Switch to Reading mode (the plugin does not work in Live Preview or Source mode)
  4. Scroll through your note — configured elements animate into focus as they enter the viewport

Note: By default, the entire container block (paragraph, list item, heading, etc.) is animated. Enable Animate word only in settings to animate just the matched word/inline element.

Settings Overview

  • Global:
    • Animation duration
    • Background opacity
    • Animate word only
    • Animate bold/italic inside highlights
  • Per tag (Highlights, Bold, Italic):
    • Enable ... float
    • ... scale amount

Demo

screenrecording-2026-02-18_13-41-57.mp4

About

This is a plugin for obsidian which highlights a block of text or a word as you scroll down while reading.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Contributors 2

  •  
  •