# Hover Outline

**English** · [简体中文](./README.zh-CN.md)

A hidden table of contents in a corner of the editor. It shows a column of short dashes (one per heading, the current one darker) and expands into an outline card on hover. Click an entry to jump there; the target line is centered.

![Left: the column of dashes, the current heading darker. Right: the outline card on hover, with a level switcher because the note has an h4.](https://raw.githubusercontent.com/MatsuriMW/hover-outline/main/docs/hover.png)

**Contents**

- [Features](#features)
- [Install](#install)
- [Feedback and updates](#feedback-and-updates)
- [License](#license)

## Features

- Choose the position in settings: left or right, top, middle or bottom (default: left, middle).
- Lists the top, headings (up to h3 by default, with a level switcher when deeper headings exist), and the bottom.
- Journal notes are split at horizontal rules into DONE / DOING / TODO sections. The journal folder follows the core Daily notes folder unless set in this plugin's settings.
- Hidden on notes containing dataview code blocks.
- On mobile, tap to open and tap again to close.

![A journal note: the card lists the DONE, DOING and TODO sections, then the first line of each remaining section.](https://raw.githubusercontent.com/MatsuriMW/hover-outline/main/docs/journal.png)

## Install

Download `main.js`, `manifest.json` and `styles.css` from [Releases](https://github.com/MatsuriMW/hover-outline/releases) into `<vault>/.obsidian/plugins/hover-outline/` and enable it under Settings → Community plugins. Or install with BRAT: `MatsuriMW/hover-outline`.

## Feedback and updates

To follow new features, send feedback or keep up with progress, follow me on Twitter: [@Matsurimywaifu](https://x.com/Matsurimywaifu).

## License

MIT