obsidian-plugin/nymbo_Markdown-Minimap
1
0
Fork 0
mirror of https://github.com/nymbo/Markdown-Minimap.git synced 2026-07-22 17:42:05 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 1
No description
25 commits 1 branch 6 tags 403 KiB
TypeScript 90%
JavaScript 6.6%
CSS 3.4%
Find a file
Nymbo 03060b4371 Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 
Render the note's Markdown source into a scaled div inside the pane for
both edit and reading modes, removing the hidden helper leaves and the
srcdoc iframe. Fixes the data-loss window in the helper force-render,
workspace pollution from hidden sidebar tabs, the stale active-view read
on leaf change, destroy/resize races, the leaked refresh button on
unload, and wrong-file renders for background notes. Adds toggle and
refresh commands, background-pane sync on vault modify, a trailing
scroll re-sync for CodeMirror height settling, and scoped reading-view
selectors so the minimap never binds itself as the scroll source.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
2026-07-22 13:37:09 -04:00
.github/workflows Address official review findings 2026-05-13 16:51:27 -04:00
scripts Convert plugin source to TypeScript 2026-05-13 15:56:22 -04:00
src Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
.gitignore Create Markdown Minimap baseline 2026-05-13 14:39:20 -04:00
esbuild.config.mjs Address official review findings 2026-05-13 16:51:27 -04:00
LICENSE Create Markdown Minimap baseline 2026-05-13 14:39:20 -04:00
main.js Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
manifest.json Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
package-lock.json Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
package.json Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
README.md Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
screenshot.png Create Markdown Minimap baseline 2026-05-13 14:39:20 -04:00
styles.css Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00
tsconfig.json Prepare 0.1.0 TypeScript release 2026-05-13 16:10:57 -04:00
versions.json Replace helper-leaf iframe minimap with direct MarkdownRenderer rendering 2026-07-22 13:37:09 -04:00

README.md

🗺️ Markdown Minimap — A Minimap View for Markdown Notes

Markdown Minimap adds a minimap panel inside your Obsidian editor pane, giving you a scaled-down visual overview of the entire note. Inspired by modern code editors, this plugin helps you navigate long Markdown files faster and with more spatial awareness.

Why this plugin?

Existing Obsidian minimap plugins lose functionality on long files — past a certain document length, the minimap stops being a usable scrollbar. Markdown Minimap is built specifically to handle long Markdown files correctly, with smooth scroll-with-document behavior similar to VS Code.

✨ Features

  • 🔎 Live minimap view of the current note - supports all view modes
  • 🖱️ Draggable viewport slider to scroll instantly
  • 🌓 Supports all themes
  • 💠 Automatically updates on scroll and content change
  • 🔁 Per-note toggle and refresh buttons in the note header, plus command-palette commands (hotkey-assignable)
  • 📏 Resizes automatically with the pane

📸 Screenshot

Screenshot of Obsidian with active minimaps.

🚀 Getting Started

📦 Installation

You can install Markdown Minimap in three ways:

1. From the Community Plugins Browser (Recommended!)

  • Open Obsidian
  • Go to Settings → Community Plugins
  • Disable Restricted Mode
  • Click Browse and search for Markdown Minimap
  • Click Install and then Enable

2. Manual Installation

  • Download the latest release from GitHub Releases
  • Extract into your Obsidian .obsidian/plugins/markdown-minimap folder
  • Make sure the folder includes:
    • main.js
    • manifest.json
    • styles.css (optional)

3. Clone Directly (For Developers)


git clone https://github.com/Nymbo/Markdown-Minimap .obsidian/plugins/markdown-minimap

🧪 Usage

  1. Install & enable the plugin.
  2. Open any markdown note.
  3. A minimap will appear on the right edge of the editor.
  4. Scroll & write in the editor — the minimap updates live.
  5. Drag the slider in the minimap to jump to different parts of the note.
  6. Click the Toggle Minimap button in the upper-right corner of the pane to choose whether to show minimap.

⚙️ Settings

  • Adjustable minimap scale
  • Enable minimap by default
  • Opacity (separate for minimap and slider)
  • Top and bottom offsets (for custom toolbars, status bars, or bottom chrome)
  • Scrollbar gap
  • Minimum viewport highlight height
  • Center-on-click behavior

📌 Implementation Notes

Full-document rendering: Obsidian's editor virtualizes long notes, which causes naive DOM-cloning minimap implementations to capture only the visible portion. Markdown Minimap instead renders the note's full Markdown source with Obsidian's own renderer into a scaled-down panel inside the pane, so the minimap always reflects the entire document regardless of length — with no hidden helper views and no iframes.

Development

Markdown Minimap is built from TypeScript source in src/main.ts.

npm install
npm run build

Use npm run dev to watch and rebuild main.js during local development.

💡 Ideas and Contributions

Contributions, bug reports, and feature requests are welcome!   Feel free to open an issue or submit a pull request.

Credits

Markdown Minimap is initially based on YairSegel/ObsidianMinimap, distributed under the MIT License.