{"id":20817332,"url":"https://github.com/galacsh/obsidian-reading-view-enhancer","last_synced_at":"2025-05-07T13:40:29.586Z","repository":{"id":148759870,"uuid":"610202324","full_name":"Galacsh/obsidian-reading-view-enhancer","owner":"Galacsh","description":"This is a Obsidian plugin that enhances reading view. Main feature: arrow keys to toggle collapse. ","archived":false,"fork":false,"pushed_at":"2025-02-09T09:46:02.000Z","size":241,"stargazers_count":24,"open_issues_count":6,"forks_count":0,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-31T10:38:43.307Z","etag":null,"topics":["collapse","fold","obsidian","obsidian-plugin","preview","reading","unfold"],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Galacsh.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-03-06T09:52:55.000Z","updated_at":"2025-02-14T09:24:30.000Z","dependencies_parsed_at":"2024-08-10T08:03:48.163Z","dependency_job_id":"6f925e5e-ba03-4290-8296-b766eb1f22e2","html_url":"https://github.com/Galacsh/obsidian-reading-view-enhancer","commit_stats":null,"previous_names":[],"tags_count":11,"template":false,"template_full_name":"obsidianmd/obsidian-sample-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galacsh%2Fobsidian-reading-view-enhancer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galacsh%2Fobsidian-reading-view-enhancer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galacsh%2Fobsidian-reading-view-enhancer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Galacsh%2Fobsidian-reading-view-enhancer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Galacsh","download_url":"https://codeload.github.com/Galacsh/obsidian-reading-view-enhancer/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252888802,"owners_count":21820067,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["collapse","fold","obsidian","obsidian-plugin","preview","reading","unfold"],"created_at":"2024-11-17T21:40:53.959Z","updated_at":"2025-05-07T13:40:29.580Z","avatar_url":"https://github.com/Galacsh.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Reading View Enhancer Plugin\n\nThe Reading View Enhancer is an Obsidian plugin designed to improve the reading experience in Obsidian's reading view mode.\nIt provides several features aimed at making the reading view more convenient and comfortable.\n\n## Features\n\n### Overview\n\n- **Keyboard block navigation**\n  - Select the next block\n  - Select the previous block\n- **Toggle collapse with keyboard**\n- **Auto-select top block on switching into reading view**\n- **Always-visible collapse indicators**\n  - Keep all collapse indicators visible\n- **Right side collapse indicator** (experimental)\n- **Scrollable code blocks**\n  - Make code blocks scrollable instead of line-wrapping\n- **Block highlighting in reading view**\n\n### Keyboard Block Navigation\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e Enable Block Selector\n\nThis feature allows you to select **blocks** in the reading view by pressing keyboard. Selected blocks will be highlighted.\n\nParagraphs, headings, lists, tables, code blocks, quotes, media elements,\nand callouts are examples of blocks.\n\n- Default key binding\n  - `ArrowDown | KeyJ`: Select the next block\n  - `ArrowUp | KeyK`: Select the previous block\n\n\u003e [!IMPORTANT]\n\u003e If a selected block is too long, the plugin will automatically scroll to display\n\u003e the block's top or bottom, loading adjacent blocks that are not yet in the DOM tree.\n\n\u003e [!NOTE]\n\u003e Additionally, there is a `Select top block in the view` command,\n\u003e which allows you to assign a hotkey for keyboard control.\n\n#### Block Color\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e Block color\n\nYou can set a custom color and transparency for the block highlight effect.\n\n### Toggle collapse with keyboard\n\nWhen a block is selected and collapsible, you can use your keyboard to toggle collapse.\n\n- Default key binding\n  - `ArrowLeft | KeyH | ArrowRight | KeyL`: Toggle collapse\n\n### Auto-select top block on switching into reading view\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e Auto-select top block\n\nWhen you switch to reading view, the top block will be automatically selected.\n\n### Always-visible Collapse Indicators\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e Always on collapse indicator\n\nBy default, collapse indicators are invisible until hovered over.  \nThis option keeps indicators always visible.\n\n### Right side collapse indicator (experimental)\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e [Experimental] Collapse indicator on the right side\n\nSet collapse indicators to be shown on the right side.\n\n\u003e [!WARNING]\n\u003e Since this makes some elements relative that were previously not, may lead some problems.\n\n### Scrollable Code Blocks\n\n\u003e ⚡️ Settings \u003e Reading View Enhancer \u003e Scrollable code\n\nThis feature makes code blocks scrollable in reading view,\nrather than using line-wrapping.\n\nBy default, codes get line-wrapped when it's too long.  \nWith this option, you can make code blocks scrollable instead of line break.\n\n\u003e [!IMPORTANT]\n\u003e This feature is for reading view. For the editor,\n\u003e install \"Style Settings\" plugin and set the code block to scrollable.\n\n### Block Highlighting in Reading View\n\nWhen a block is selected, you can highlight the block right away in the reading view by running the command:\n\n`Reading View Enhancer: Toggle Block Highlight`.\n\n\u003e [!TIP]  \n\u003e Assign a hot key for more convenient use.  \n\u003e For example, I use `Ctrl + Shift + h`.\n\n\u003e [!NOTE]  \n\u003e **Why it blinks during the highlight?**  \n\u003e This is because the plugin changes to 'editor' mode to insert the `==` syntax for highlighting and then changes back to 'reading' mode.\n\u003e\n\u003e This is the only way I found to toggle the highlight while **keeping the editing history**. You can always undo the highlight by pressing `Ctrl + z` in the editing mode.\n\n## How to install manually?\n\nBy using [Obsidian42-BRAT](https://obsidian.md/plugins?id=obsidian42-brat), you could easily install \u0026 update this plugin.\n\n1. Install **Obsidian42-BRAT**\n2. Enable Obsidian42-BRAT\n3. Go to Obsidian42-BRAT options page\n4. Beta plugins list \u003e `Add Beta plugin`\n5. Paste this `https://github.com/Galacsh/obsidian-reading-view-enhancer`\n6. Go to `Settings \u003e Community Plugins \u003e Installed plugins`\n7. Refresh the list\n8. Turn on the switch of \"Reading View Enhancer\" to enable the plugin\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacsh%2Fobsidian-reading-view-enhancer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fgalacsh%2Fobsidian-reading-view-enhancer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fgalacsh%2Fobsidian-reading-view-enhancer/lists"}