【Obsidian】Obsidian gitプラグインのメモ
マークダウンエディタのObsidionは、ドキュメントの作成や思考の整理に適したツールですが、基本的に保存先はローカルドライブになります。
そのため、複数台のPCを使用していると、ファイルの同期を何らかの方法で行う必要があります。
また、バックアップも自己管理となります。
この問題を解消するため、サードパーティープラグインとして公開されている「Obsidian git」プラグインについて簡単に説明します。
2022/04/11 追記: この記事を記載後、プラグインのバージョンアップが進み、機能が充実しています。
設定項目もその分増えていますので、以下に2022/4時点で最新のプラグイン(1.24.1)をベースに記載した記事を投稿していますので、こちらを参照願います。 aburi6800.hatenablog.com
目次
Obsidian gitプラグインとは
- ObsidianでGitリポジトリへのpush、pullを行えるサードパーティープラグイン。
- Githubなどのリモートリポジトリを介して複数端末からファイルを編集できるようになるので便利。(リモートリポジトリがバックアップにもなる)
- 事前にGitのリモートリポジトリの作成とSSH接続の設定を行っておく必要があるので、若干敷居が高い。
GithubとのSSH接続に関しては、Web上に解説記事があるので、そちらを参照ください。(気が向いたらこのブログにも書きます)
使用方法
Obsidianがインストールされている前提で、以下を行う。
設定
- Valut Backup Interval (minutes):自動的にリモートリポジトリにpushする間隔を分で指定する。
- Commit message:リモートリポジトリへのコミットメッセージを指定する。
{{date}}
のフォーマットは次で指定可能。 - {{date}} placeholder format:コミットメッセージの
{{date}}
の書式を設定する。 - Preview commit message:上記で設定したコミットメッセージをプレビューする。
- Current branch:push先のブランチを指定する。(通常はmasterのままでOK)
- Pull updates on startup:Obsidian起動時にリモートリポジトリからpullするかを設定する。(ON推奨)
- Disable push:リモートリポジトリへのpushを禁止する。(通常はOFFでOK)
- Disable Notifications:通知表示をOFFにする。(右上の表示が鬱陶しい場合はONにする)
コマンド
ホットキーは初期設定時は割当なし。 以下は私の(今のところの)設定例です。
コマンド | 説明 | ホットキー |
---|---|---|
Obsidian git: Pull from remote repository | リモートリポジトリからpullする | [Ctrl]+[Shift]+[P] |
Obsidian git: Commit all changes and push to remote repository | 全ての変更ファイルをcommitし、リモートリポジトリにpushする | [Ctrl]+[Shift]+[Enter] |
※作業終了時に必ず[Ctrl]+[Shift]+[Enter]を叩く癖をつける
注意点
- 競合が発生した場合、マージは手動で行う必要があるので注意。(=チームでの共同作業には向かないかも知れない)
.obsidian/workspace
は各端末での画面の状態を保存しているファイルなので、.gitignoreに登録推奨。
総括
このプラグイン、説明ページにも使用方法が明確に書かれていなかったり(私が見落としただけ?)、機能が最低限のため競合が発生すると別手段での解消が必要になったりと、少々不親切な部分がありますが、1台のみでObsidianを使っていたとしてもGitリポジトリにバックアップが取れるので、Obsidianを使用しているなら試してみる価値はあります。
他にDropboxやOneDrive経由で同期する手段もありますが、Dropboxは無料アカウントでの制約が厳しくなったし、Linuxも併用するならGitが一番汎用的で使いやすいのではないでしょうか。
なお、スマートフォン/タブレットでは、AndroidではGitJournalというアプリで、Githubのリモートリポジトリへの接続やマークダウン形式のドキュメントを扱うことができます。(iPhoneは色々とあるようですが、持っていないので未調査)
なお、Obsidianのモバイルアプリが開発中、2021年中にリリースされる予定とのことなので、期待しています。