🎉

Obsidian ブックマークしたファイルを簡単に開くことができるプラグインをリリース

2024/04/27に公開

はじめに

Bookmarks Callerというブックマークしたファイルを簡単に開くことできるようになるObsidianプラグインをリリースしました。

Obsidianのコアプラグインの1つにブックマークがあります(ブックマーク機能詳細は以下リンク先を参照)。

Obsidian公式ヘルプページ - Bookmarks

よく使うファイルなどをブックマークすると、ブックマーク一覧からその項目をすぐに表示することができます。

ただ、デフォルトではそのブックマーク一覧を表示するのが少し手間であり、折角ブックマークしたファイルも開きづらいとジレンマがあると思います。
それをこのプラグインで解消できます。

version0.5.0: 登録済みのブックマークを検索して開く機能を追加しました。

本記事ではBookmarks Callerの機能紹介、その他雑記(開発の背景、コンセプトなど)を書きます。

Bookmarks Callerのリンク

オススメしたい人

  1. Obsidianアプリを使っている人
  2. ブックマーク機能を利用している人
  3. 今はブックマーク機能を利用していないけど、よく開くファイルがある人

機能紹介

機能: ブックマークを開く(1ファイル指定)

まず、Bookmarks Caller: Open bookmarks callerコマンドを実行すると、ブックマークをリストアップしたモーダルが表示されます。
(コマンドはホットキーを割り当てておくことを推奨します)

次に表示されているブックマークの一覧から開きたいブックマークを見つけて、横にある1文字のキーを入力するとそのブックマークを開くことができます。
(矢印キーでフォーカスを移動してEnterまたはSpaceキーで項目を選択する、あるいはマウス操作やタップで項目を選択することでも同様に切り替えできます。)
※それぞれの1文字のキーは設定画面でで変更できます。

Open bookmark

機能: ブックマークを開く(グループ指定)

コアプラグインのブックマーク機能にはブックマークをグルーピングする機能があります。
グループ(フォルダのようなもの)を作成し、グループの中にブックマークを格納して整理することができます。
このプラグインではグループの中にあるファイルを一括で開くことができます。

まず、Bookmarks Caller: Open bookmarks callerコマンドを実行します。
その後、一括で開きたいグループに移動して/キーを入力すると、そのグループ配下のファイルを一括で開くことができます。
※デフォルトは/キーを利用しますが設定画面で変更できます。

Open all bookmarks

機能: ブックマークを開く(1ファイル指定) - 検索して開く(version0.5.0)

Bookmarks Caller: Search bookmarksコマンドを実行すると、検索入力欄とブックマークをリストアップしたモーダルが表示されます。
(コマンドはホットキーを割り当てておくことを推奨します)

検索入力欄にキーワードを入力して開きたいブックマークを絞り込んで選択することでブックマークを開くことができます。
(矢印キーでフォーカスを移動してEnterキーで項目を選択する、あるいはマウス操作やタップで項目を選択することでも同様に切り替えできます。)

Search bookmarks

機能: ブックマークを開く(グループ指定) - 検索して開く(version0.5.0)

まず、Bookmarks Caller: Search bookmarksコマンドを実行します。
その後、一括で開きたいグループに移動してShift + Enterキーを入力すると、そのグループ配下のファイルを一括で開くことができます。

その他雑記

開発背景

僕は普段Obsidianを利用しているとき、利用頻度に応じて以下のようにファイルを開いています。

  • 高頻度で使うファイル: 常時ファイルを開きっぱなしする
    • 常に1時間に1回は利用するファイル
  • 特定の作業時のみ必要になるファイル: ファイルを利用した後しばらく不要になった時点で閉じる
    • 1日に1回以上は利用するファイル
    • その他のファイル

この特定の作業時のみ必要になるファイルの中でも1日に1回以上は利用するファイルが割と開くことが手間に感じていました。
そのときに「そういえばブックマーク機能があったよな」と思い出してブックマークを登録して利用し始めました。
ブックマークを表示コマンドでブックマーク一覧を表示して任意のファイルを開きやすくなりました。

ただ、はじめにでも記載したように、このブックマーク一覧を表示するという操作が手間に感じました。

  1. ブックマークを表示コマンドを実行して左サイドバーを開いてブックマーク一覧を表示
  2. 任意のファイルを探してマウス操作で選択してファイルを開く
  3. 不要になった左サイドバーをホットキーで閉じる

特に「マウス操作がいること」、「左サイドバーを閉じ直すこと」が手間でした。

そこですでにリリースしていたTab SelectorのUIを継承しつつ、本プラグインを開発しました。
※Tab Selectorについてはこちらの記事を参照。

開発コンセプト

Tab Selectorプラグインと同様に少ない動作・操作で好きなファイルを開けるがコンセプトです。
少ない動作はキーボードから手を離さずにキーボード操作だけで完結できることを意識しました。
少ない操作はキーボード操作の入力回数を極力減らすことを意識しました。

また、例えば作業ごとに必要になるブックマークをグルーピングしておき、一括で開けるようにすることで1ファイルずつ開くという手間も削減できることを目指しました。

開発・リリースして気づいたこと

実はブックマーク機能のすべてに対応はできていない状況です。
Obsidianでブックマークできる項目は6種類あります。
(詳細はこちら)

当初ブックマークできるのはファイルだけと思っていたのですが、リリースしようと思っていた直前に他に5種類あることに気付きました。
僕自身が普段利用する際に必要なブックマークはBookmark a fileだけでしたが、公開するなら可能な限りサポートしたいと思って追加でいくつか開発しました。

現時点のサポート状況は以下の通りです。

  • サポート済み
    • Bookmark a file
    • Bookmark a folder (v0.3.0でサポート追加済み)
    • Bookmark a search term (v0.2.0でサポート追加済み)
    • Bookmark a heading
    • Bookmark a block
    • Bookmark a graph (v0.4.0でサポート追加済み)
  • 未サポート
    • (Obsidian version1.5.12時点で未サポートなし)

未サポートのBookmark a search termは近日中にサポートする予定です。
Bookmark a folderBookmark a graphのサポートはまだ見通しがありませんが、マイペースにサポートする方法を探していこうと思っています。
未サポートだったBookmark a search termはv0.2.0、Bookmark a folderはv0.3.0、Bookmark a graphはv0.4.0でサポートしました。

さいごに

このプラグインを利用することでブックマークしたファイルを開きやすくなり、そもそもの「ファイルをブックマークする」という機能はやっぱり便利だなと感じています。

どのくらいの数のObsidianユーザがコアプラグインのブックマークを利用されているかは分からないですが、まだ利用されていな方は是非一度使ってみて欲しい機能です。
ブックマーク機能を活用されるときに本プラグインがその手助けになれば嬉しいです。

Discussion