- Notifications
You must be signed in to change notification settings - Fork0
This is a Obsidian plugin that enhances reading view. Main feature: arrow keys to toggle collapse.
License
Galacsh/obsidian-reading-view-enhancer
Folders and files
| Name | Name | Last commit message | Last commit date | |
|---|---|---|---|---|
Repository files navigation
The Reading View Enhancer is an Obsidian plugin designed to improve the reading experience in Obsidian's reading view mode.It provides several features aimed at making the reading view more convenient and comfortable.
- Keyboard block navigation
- Select the next block
- Select the previous block
- Toggle collapse with keyboard
- Auto-select top block on switching into reading view
- Always-visible collapse indicators
- Keep all collapse indicators visible
- Right side collapse indicator (experimental)
- Scrollable code blocks
- Make code blocks scrollable instead of line-wrapping
- Block highlighting in reading view
⚡️ Settings > Reading View Enhancer > Enable Block Selector
This feature allows you to selectblocks in the reading view by pressing keyboard. Selected blocks will be highlighted.
Paragraphs, headings, lists, tables, code blocks, quotes, media elements,and callouts are examples of blocks.
- Default key binding
ArrowDown | KeyJ: Select the next blockArrowUp | KeyK: Select the previous block
Important
If a selected block is too long, the plugin will automatically scroll to displaythe block's top or bottom, loading adjacent blocks that are not yet in the DOM tree.
Note
Additionally, there is aSelect top block in the view command,which allows you to assign a hotkey for keyboard control.
⚡️ Settings > Reading View Enhancer > Block color
You can set a custom color and transparency for the block highlight effect.
When a block is selected and collapsible, you can use your keyboard to toggle collapse.
- Default key binding
ArrowLeft | KeyH | ArrowRight | KeyL: Toggle collapse
⚡️ Settings > Reading View Enhancer > Auto-select top block
When you switch to reading view, the top block will be automatically selected.
⚡️ Settings > Reading View Enhancer > Always on collapse indicator
By default, collapse indicators are invisible until hovered over.
This option keeps indicators always visible.
⚡️ Settings > Reading View Enhancer > [Experimental] Collapse indicator on the right side
Set collapse indicators to be shown on the right side.
Warning
Since this makes some elements relative that were previously not, may lead some problems.
⚡️ Settings > Reading View Enhancer > Scrollable code
This feature makes code blocks scrollable in reading view,rather than using line-wrapping.
By default, codes get line-wrapped when it's too long.
With this option, you can make code blocks scrollable instead of line break.
Important
This feature is for reading view. For the editor,install "Style Settings" plugin and set the code block to scrollable.
When a block is selected, you can highlight the block right away in the reading view by running the command:
Reading View Enhancer: Toggle Block Highlight.
Tip
Assign a hot key for more convenient use.
For example, I useCtrl + Shift + h.
Note
Why it blinks during the highlight?
This is because the plugin changes to 'editor' mode to insert the== syntax for highlighting and then changes back to 'reading' mode.
This is the only way I found to toggle the highlight whilekeeping the editing history. You can always undo the highlight by pressingCtrl + z in the editing mode.
By usingObsidian42-BRAT, you could easily install & update this plugin.
- InstallObsidian42-BRAT
- Enable Obsidian42-BRAT
- Go to Obsidian42-BRAT options page
- Beta plugins list >
Add Beta plugin - Paste this
https://github.com/Galacsh/obsidian-reading-view-enhancer - Go to
Settings > Community Plugins > Installed plugins - Refresh the list
- Turn on the switch of "Reading View Enhancer" to enable the plugin
About
This is a Obsidian plugin that enhances reading view. Main feature: arrow keys to toggle collapse.
Topics
Resources
License
Uh oh!
There was an error while loading.Please reload this page.
Stars
Watchers
Forks
Uh oh!
There was an error while loading.Please reload this page.