# Joplin Minimap

[Joplin](https://joplinapp.org/) のノートビューア用、ホバーで展開する目次ミニマップ。右端に見出しのティックバーを表示し、ホバーするとクリック可能なアウトラインに展開します。

[English](README.md) | [中文说明](README-CN.md)

## 機能

- **ティックバー・ミニマップ** — 各見出しをビューア右端に短い横線で表示。線の長さは見出しレベルを表します(H1 が最長)
- **ホバーで展開** — マウスを乗せると、レベルごとにインデントされた完全な目次オーバーレイに展開。長いタイトルは省略記号で切り詰め
- **クリックでジャンプ** — 項目をクリックすると該当見出しへスムーズスクロール
- **現在位置の表示** — 表示中のセクションを自動でハイライト
- **自動再構築** — ノートの切り替えや編集時に自動で再構築(`joplin-noteDidUpdate` を監視、MutationObserver でフォールバック)
- **テーマ対応** — ライト/ダークテーマに自動追従(`currentColor` から色を継承)
- **邪魔をしない** — 見出しが 2 個未満のノートでは非表示。印刷/エクスポート時も非表示。フォーカスやキーボード入力を奪いません

## インストール

### Joplin プラグインリポジトリから(公開後)

1. Joplin → **ツール → オプション → プラグイン**
2. **Joplin Minimap** を検索
3. インストールして Joplin を再起動

### ファイルから

1. [最新リリース](https://github.com/lim0513/joplin-minimap/releases/latest) から `plugin.jpl` をダウンロード
2. Joplin → **ツール → オプション → プラグイン**
3. 歯車アイコンから**ファイルからインストール**を選択
4. ダウンロードした `.jpl` ファイルを選択
5. Joplin を再起動

## 使い方

見出しが 2 個以上あるノートを**レンダリングされた Markdown ビューア**(閲覧モード、または分割エディタのプレビュー側)で開きます:

- 右端にティックバーの列が表示されます
- **ホバー**すると完全な目次に展開
- **クリック**で該当見出しへジャンプ

注意:ミニマップはレンダリングビューアのみに表示されます。Markdown エディタやリッチテキストエディタには表示されません。

## 仕組み

markdown-it コンテンツスクリプトがビューアに 2 つのアセットを注入します。`minimap-view.js` がレンダリング後の `h1`–`h6` 要素からミニマップを動的に構築し、`minimap.css` が折りたたみ/展開のスタイルを担当します。Markdown のレンダリング自体には手を加えません。

## 設定

**ツール → オプション → Joplin Minimap** で設定できます:

- **最少見出し数** — ノートの見出しがこの数未満の場合はミニマップを非表示(デフォルト 2)
- **展開パネルの幅 (px)** — ホバーで展開した目次の最大幅(デフォルト 240)
- **右端からの距離 (px)** — ミニマップとビューア右端の間隔(デフォルト 6)

変更は次回レンダリング時(ノート切り替えや編集時)に反映されます。

## 開発

依存関係ゼロ、`npm install` 不要:

```bash
npm run dist
```

`dist/`(Joplin の **Development plugins** 設定でプロジェクトルートを指定して読み込み可能)と `publish/`(`publish/plugin.jpl` を含む)が生成されます。

## ライセンス

MIT