guide

document-minimap

A right-rail overview of a document — caller-styled markers at proportional positions, a draggable viewport band that tracks scroll, and jump-to-marker on click.

Markers styled by caller-injected kind. Drag the band or click a marker to jump.

Click a marker to jump.

Three marker kinds (section, figure, note) styled by the caller. Drag the band or click a marker to jump.

Installation

Usage

Use when

  • Long documents where a bird's-eye view helps navigation — API docs, specs, manuscripts