# List Guide Bridge

List Guide Bridge is a companion plugin for [Obsidian](https://obsidian.md/) that adds vertical hierarchy guides to sections indented by [Heading Level Indent](https://github.com/svonjoi/obsidian-heading-level-indent).

## What it does

- Draws a vertical guide for each heading section in Reading view.
- Aligns every guide with the left edge of its heading.
- Supports nested heading levels, so H2, H3, and deeper sections receive parallel hierarchy guides.
- Reads the indentation applied by Heading Level Indent instead of duplicating its settings.
- Applies the current heading indentation to rendered Mermaid diagrams, which Heading Level Indent 3.0.0 does not indent itself.
- Keeps guides continuous across paragraphs, lists, callouts, images, Mermaid diagrams, and other rendered blocks.
- Never modifies note content and does not run in Live Preview or Source mode.

## Requirements

- Obsidian 1.5.0 or newer.
- [Heading Level Indent](https://github.com/svonjoi/obsidian-heading-level-indent), tested with version 3.0.0.

Install and enable Heading Level Indent before enabling List Guide Bridge. Configure the heading offsets in Heading Level Indent; the guides and Mermaid indentation update from the rendered values automatically.

## Installation

### Community plugin directory

Once accepted, install the plugin from the official [Obsidian Community Plugins directory](https://obsidian.md/plugins):

1. Open **Settings → Community plugins**.
2. Select **Browse** and search for **List Guide Bridge**.
3. Install and enable it.

### Manual installation

Download `main.js`, `manifest.json`, and `styles.css` from the GitHub release whose tag matches the version in `manifest.json`. Place the files in:

```text
<vault>/.obsidian/plugins/list-guide-bridge/
```

Reload Obsidian and enable **List Guide Bridge** under **Settings → Community plugins**.

## Privacy and permissions

List Guide Bridge:

- makes no network requests;
- includes no telemetry or analytics;
- does not access files outside the vault;
- does not modify Markdown files;
- only inspects and decorates the rendered Reading-view DOM.

## Development

```bash
npm install
npm run build
```

The production build writes `main.js` at the repository root. For development builds with an inline source map, run:

```bash
npm run dev
```

The active entry point is `src/main.ts`.

## Releasing

1. Update `version` in `manifest.json` and `package.json`.
2. Add the version to `versions.json`.
3. Run `npm ci`, `npm exec tsc -- --noEmit`, and `npm run build`.
4. Commit the release.
5. Create and push a Git tag exactly matching the version, for example `1.1.0` without a `v` prefix.
6. The included GitHub Actions workflow creates a release containing `main.js`, `manifest.json`, and `styles.css` as individual assets.

## Relationship to Heading Level Indent

This is an independent companion project, not a fork. It contains no source code copied from Heading Level Indent. It relies on the rendered classes and indentation produced by that plugin and adds hierarchy guides plus Mermaid compatibility on top.

Heading Level Indent was created by [svonjoi](https://github.com/svonjoi). Its repository is available at [svonjoi/obsidian-heading-level-indent](https://github.com/svonjoi/obsidian-heading-level-indent).

## License

Copyright © 2026 Suzkapu.

List Guide Bridge is licensed under the [GNU Affero General Public License v3.0 only](LICENSE).

Obsidian is a trademark of Dynalist Inc. This community project is not affiliated with or endorsed by Dynalist Inc.