/obsidian-focus-plugin

A plugin for obsidian to focus and highlight on a specific heading in Reading mode.

Primary LanguageTypeScriptMIT LicenseMIT

Focus and Highlight

A plugin for obsidian to focus on a specific paragraph in Reading mode.

Features

  • Focus on a specific heading and its children when clicking on them.
    • For now, focusing "only" on lists or other blocks is not supported.

Usage

  1. The plugin is now available in community plugins list! You can download the plugin directly through Obsidian's Settings > Community plugins Tab.
    • You can also install with BRAT, with the repository name nagi1999a/obsidian-focus-plugin.
  2. Enable the plugin named Focus and Highlight in Obsidian's Settings > Community plugins Tab.

Once the plugin is installed and enabled, you can focus on different headings by clicking on any of them.

Options

You can adjust the behavior of this plugin by accessing Obsidian's Settings > Focus and Highlight Tab.

Clear Method

This option affects the way to clear the focus state.

Click Again

Clear the focus state by clicking again on the focused heading.

Click Outside

Clear the focus state by clicking on the blank area at the left or right side of the reading area, which may not work correctly when Settings > Editor > Readable line length is turned off.

Style Settings

With the Style Settings plugin installed and enabled, you can further customize some visual properties under Settings > Style Settings > Focus and Highlight.

Dim Opacity

Set the opacity of dimmed elements. Default is 0.1.

Dim Speed

Set the speed of the animation in seconds. Default is 0.5.

Discussion

Behavior under Mutiple Panes

The plugin now supports multi-pane scenarios. Different panes will be able to focus on their headings, as the following GIF shows.

Issues

If you encounter any problems or have suggestions about the plugin, please feel free to open issues.