https://github.com/luckman212/obsidian-open-to-offset

Registers a URI Scheme for Obsidian to allow opening a file to an absolute offset
https://github.com/luckman212/obsidian-open-to-offset

obsidian obsidian-md obsidian-plugin

Last synced: about 1 month ago
JSON representation

Registers a URI Scheme for Obsidian to allow opening a file to an absolute offset

• Host: GitHub
• URL: https://github.com/luckman212/obsidian-open-to-offset
• Owner: luckman212
• Created: 2024-05-24T14:48:47.000Z (8 months ago)
• Default Branch: main
• Last Pushed: 2024-06-08T12:55:52.000Z (8 months ago)
• Last Synced: 2024-12-17T14:12:40.484Z (about 1 month ago)
• Topics: obsidian, obsidian-md, obsidian-plugin
• Language: TypeScript
• Homepage:
• Size: 10.7 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Obsidian Open to Offset Plugin

Registers a URI Scheme (protocol handler) to allow opening a file to a specific absolute offset. `scrollIntoView()` is executed to attempt to center the view around your requested offset.

Right now this is primarily useful as a companion to [Omnisearch][1], since those results are given in offset rather than line/column.

## Install

For now, install must be done manually.

1. Download and unzip the latest [release][2]

2. Place the expanded folder in your `.obsidian/plugins` directory

3. Enable the plugin in Settings → Community plugins

## How to use

Pass `file` and `offset` as URL params:

```

open 'obsidian://open-to-offset?file=MyFile.md&offset=1234'

```

There is some basic bounds checking, if you supply an offset greater than the length of the file, it will scroll to the end of the file instead rather than emitting an error.

[1]: https://github.com/scambier/obsidian-omnisearch

[2]: https://github.com/luckman212/obsidian-open-to-offset/releases