この記事で獲得できるモノ
- Obsidianで作成したMDをGitHubで管理することができる。
- Obsidian - Gitの連携方法を理解することができる。
1. OBJECTIVE - 目的
記事をご覧いただきありがとうございます。
本稿では、ローカルノートアプリであるObsidianで作成したMD（Markdown）ファイルを、ローカルディスクのVault（Obsidianにおけるプロジェクトのようなもの）に保存・管理・更新しながら、GitHubのリポジトリへPushしネットワーク上での管理を目指します。
私自身、まだまだObsidianやGitに関しても知識が浅いですが、備忘録を兼ねてPostさせていただきます。
2. REQUIREMENTS - 必要なモノ
本稿の目的を達成するためには、以下のモノが必要になります。
- Git
- GitHub Desktop
- Obsidian
3. PROCEDURE - 手順
1. GitとGitHubをAvailableにする。
GitおよびGitHubの導入については本稿では割愛いたします。以下のブログでわかりやすく解説しておりますので、ご参照ください。
2. Obsidianをインストールする。
Obsidianは下記よりインストーラーを入手してください。
セットアップについては下記をご参照ください。
Obsidianを知りたい方は下記のページが参考になるかと思います。とても分かりやすいです。
3. Obsidian VaultとGit Repositoryを紐づける
GitHub DesktopよりRepositoryを作成します。
- Fileタブより、New repository...をクリックします。
- Create a new repository画面が表示されるので、必要事項を記入してRepositoryを作成します
- Name... Repositoryの名前を入力してください。
- Description... Repositoryの説明を入力してください。
- Local Path... ローカルディスク上の任意のフォルダを選択してください。後ほど、このローカルフォルダをObsidianのVault（プロジェクト）として指定します。
ほか設定項目は現状無視でOKです。必要に合わせて設定してあげてください。
作成したRepositoryをGitHubへPublishする。
- Repositoryを作成すると、以下のような画面に遷移しますので、Publish repositoryをクリックします。
- Publish repositoryの画面が表示されます。ここで着眼してほしいのは、Repositoryを非公開にするか否かです。
ここでは非公開のまま作成します→Keep this code privateにチェックをつける。
ObsidianでVaultを開く。
- いよいよObsidianの登場です。
- 保管庫としてフォルダを開く、をクリックして作成したRepositoryのローカルフォルダを指定します。
- フォルダを指定すると、Obsidianのワークスペースが開きます。次はObsidian Gitの設定です。
Obsidian Gitのセットアップ
- 左下の歯車アイコンをクリックして、コミュニティプラグインをクリックします。
- コミュニティプラグインを有効化をクリックし、コミュニティプラグインを閲覧します。
- 検索ボックスで「Obsidian Git」と検索し、ヒットしたプラグインをインストール・有効化します。
- オプションのホットキー項目に画面を切り替え、Gitでフィルタをかけます。
- 以下３つのアクションを探し、ホットキーを割り当てます。以上でセットアップは完了。
- Obsidian Git: Commit all changes = Ctrl + Shift + C
- Obsidian Git: Pull = Ctrl + Shift + P
- Obsidian Git: Push = Ctrl + Shift + S
Let's TRY!!
実際にMDファイルを作成して、Git RepositoryにCommit -> Pushされるか確認してみましょう。
新規ファイルを作成し、任意のタイトルを入力します。
テキスト本文にも、任意の文字列を入力してあげます。
入力完了後、先程設定したホットキーを使います。まずファイルに変更があった場合には、コミットを行います。
したがって、Ctrl + Shift + Cを入力してファイルをコミットしましょう。
Obsidianの右上からファイルをコミットした旨のラベルがちろりと出てきたと思います。コミットはこれで成功です。
次は実際にPushしましょう。PushのホットキーはCtrl + Shit + Sですね。トライしてみましょう。
数秒ほど間を開けて、Remote repositoryへファイルをPushした旨のラベルがちろりしましたね。Push成功です。
本当に成功しているか、GitHubへ確認しにいきましょう。
うまく行ってますね。これで以上です。