経緯
- 技術系のTips記事(静的サイト)をMaterial for Mkdocs(以降MkDocsと表現する)で作成したドキュメント(Markdown)をGitHubで管理し、Netlifyでデプロイすることでwebサイトとして公開していた。
- 個人の作業ログやメモはObsidianアプリを使用して管理していた。
- データはWindows/Mac/iPhone/iPadで参照、更新するため、データの保存先(保管庫:Obsidian vault)はiCloudを指定して保存していた。
- MkDocsはWebページとして生成されるが、materialテーマにより統一的なデザインで構成されるためスマートフォンやPCで見やすい。ただし、ドキュメント更新は主にPCでVSCodeから行う必要があった。
- 文章量が多い場合はPCでも良いが、毎回起動するのは手間だと感じていた。そこで、スマートフォンでもドキュメントを更新する方法がないか検討していた。
- 一例として、はてなブログでは、スマートフォン向けもアプリが公開されており、PC、スマートフォンで両方で更新可能な例も存在する。
仕様検討
要件
- ドキュメント表示はMkDocs、更新はObsidian、または、VSCodeとする。
- ドキュメント(コード)はGitで管理し、セキュリティを考慮してGitHubのプライベートリポジトリで管理する。
- 費用はなるべく抑えたい。希望は無料で利用できること。
技術選定
Obsidianでは、ウェブサイト上に公開するサービスとしてObsidian Publishが提供されているが、月額制のサービスであるため対象から除いた。1
マルチデバイスで更新可能にするために保管庫はiCloudで設定することが前提になる。ローカル保管庫の変更を自動的に同期するサービス(リモートでも設定次第で可能)として、Obsidian Syncが提供されているが、こちらも有料の月額サービスであるため対象から除いた。2
ObsidianでGitを利用する方法として、Obsidian-Gitプラグインを利用することで、元データをgitのリポジトリの情報で設定できる。PCでは任意のローカルディレクトリを指定可能なので問題なし。iPhone,iPadの場合は、ファイル(ローカル)のobsidianフォルダ以下のみ対象であるため、ここにgit cloneする必要があるが、これはa-Shellアプリを使用すれば対応可能であった。3
設定方法
以降の内容は以下のページを参照ください。
7rikazhexde-pkm-obsidian-mkdocs.netlify.app
以上です。
- 興味はあるので今後使用する可能性はある。調べると、tadashi-aikawaのPKMとして公開されているMinervaではObsidian Publishを使用して運用されている。使用する場合は内容が参考になるため共有させていただきます。↩
- Obsidian Syncに記載の通り、機能も充実しているので利用価値は高いと言える。↩
- gitコマンドのインストールが必要(インストール方法詳細)↩