---
title: "Getting Started"
description: "Zero-config sidebar navigation for the Kirby Panel – jump between fields and blocks in complex blueprints with a single click."
canonical_url: "https://kirby.tools/docs/minimap"
---

# Getting Started

> Zero-config sidebar navigation for the Kirby Panel – jump between fields and blocks in complex blueprints with a single click.

Kirby Minimap is a free plugin for [Kirby CMS](https://getkirby.com). Install it, and a structured sidebar appears next to the site view and every page view – no license activation, no setup.

## Step 1: Install the Plugin

<card icon="i-ri-terminal-box-line" title="Composer">

The recommended way to install the plugin:

```bash
composer require johannschopplich/kirby-minimap
```

</card>

<card icon="i-ri-folder-zip-line" title="ZIP File Download">

Download the <latest-version>



</latest-version>

 or head over to the [releases page](https://github.com/johannschopplich/kirby-minimap/releases) to see all versions. Extract the ZIP file to your `site/plugins` folder.

</card>

## Step 2: Start Using the Minimap

Open the site view or any page – the minimap appears on the right side of the Panel.

### Navigation States

The minimap has two states. Hover the minimap and click the arrow button that appears near the top of its inner edge to switch between them:

1. **Collapsed State**<br />


Displays a minimal vertical indicator with positional markers for each field, maintaining an unobtrusive presence.
2. **Expanded State**<br />


Reveals the complete navigation interface, showing field names and block details.

### Scroll Position

Navigation runs both ways. Every field and block currently in the viewport is marked active in the minimap, so scrolling the form moves the highlight along with it – in the collapsed state too, where the markers are the only cue to where you are in a long blueprint.

### Tab Awareness

The minimap is tab-aware: when your blueprint uses tabs, the minimap displays only the fields from the currently active tab. Switching tabs automatically updates the minimap to reflect the new content structure.

---

Every page of this site as Markdown: <https://kirby.tools/sitemap.md>