Zenn & Hugo in Obsidian : OHZフローによるナレッジベースとアウトプットコンテンツの完全統括
はじめに
Zenn や Hugo を Obsidian で利用して運用するためのアイデアとその方法をまとめました。スクラップ上でまとめたもの を記事化してます (追加の内容あり)。
日本ではまだ広く知られていない PKM 周りの概念や新たなツールの紹介も含むの分かりづらいところや説明が長くなってしまう部分もありますが興味を持っていただければ幸いです。
また、ここで紹介するやり方は Obsidian の公式で紹介されてないような応用的な使い方になるので潜在的な問題があるかもしれません。自己責任の元で適宜各ディレクトリのバックアップを行いながら環境構築をしてください。(自分の環境では現在のところ特に問題は発生していません)
ChangeLog
- 2020-12-11:
- 目次｢はじめに｣追加
- ｢得られるメリット｣の内容を revise
- 2020-12-20:
- ｢注意点｣の項目を追加
- ｢利用上の注意点｣の内容を追加
- ｢PDF 出力｣の項目を追加
- ｢git による複数リポジトリでの管理｣の項目を追加
- 2020-12-23:
- 冒頭文追加
- wikilink の修正
- タイポの修正
- フロントマターとエイリアスについて追加
- 2020-12-26:
- ｢ノートの転送｣の項目を追加
- 画像の差し替え
- 2021-01-03
- ｢思考収束の盲点｣の項目を追加
- ｢課題 3: フォルダ除外｣の項目を追加
対象読者
- メモ魔の人
- Evernote や Notion 等のメモアプリを使ったことがある人
- ナレッジベースに興味がある人
- 新しいツールが好きな人
- プレーンテキストが好きな人
- マークダウンが好きな人
- Zenn を使い始めた人
- Zenn だけでなくブログなども書きたい人
- 記事をエディタからコピペしたくない人
- 効率的なアウトプットをしたい人
- 学習を効率化したい人
- テキストを書くすべての人
感想や疑問、アイデア等があれば Discussion の方に気軽にコメントしてください。
Obsidian/Hugo/Zenn
Obsidian 内にて Hugo と Zenn を利用して、ナレッジベースとアウトプットコンテンツのローカル環境での 完全統括 を目指し、あらゆるノートとそこからアウトプットとして作成した記事に散らばる アイデアと知識の再利用と循環 を行うための環境 (知識循環メモ環境) 構築のための方法を考える。
- Obsidian : Markdown knowledge base app
- ローカル環境 と マークダウン ファイルを使った新しい PKM ツール
- graph ビューや ウィキリンク という wikipedia で使われてる二重ブラケット記法
[[wikilink]]やマークダウンのリンク記法[]()を使って知識やアイデアをつなげることができる。
- Hugo : Static site generator
- ローカル環境 で書いた マークダウン ファイルを使って静的サイトを爆速でビルドできるツール
- git と Netlify などのホスティングサービスを利用すれば無料で静的サイトを運用できる
- Zenn : Knowledge base Community
- note のような課金機能を搭載している
- デベロッパー用のナレッジベース&コミュニティ
- 本や記事を マークダウン で書ける
- zenn-cli と git を使えば、ローカル環境 で執筆できる
すべて ローカル環境 と マークダウン を利用してコンテンツ作成が可能 (ただしマークダウンのフレーバーがそれぞれ若干異なる部分があるのでそこは注意)
Zenn や Hugo については知ってるけど Obsidian についてはもっと基本的なことから知りたいという人がいると思うので、その場合には jMatsuzakiさん と 滝林さん がかなり詳しく紹介されているので参照してみてほしい。
PKM とは
そもそも PKM とは何か?
Personal Knowledge Management (個人知識管理) の略。PKM のツールとして PKB(Perosnal Knowledge Base) がある。
PKB として Evernote や Notion などの電子メモツールなどが相当するが、Scrapbox や Roam Research、Obsidian といった networked thought(ネットワーク化された思考) を補助し｢第二の脳をつくる｣ためのアプリケーションツールが最近注目されている。wikipedia のようなリンクをつかったハイパーテキストによる wiki を個人で作り上げることができる。
Networked thinking is an explorative approach to problem-solving, whose aim is to consider the complex interactions between nodes and connections in a given problem space. Instead of considering a particular problem in isolation to discover a pre-existing solution, networked thinking encourages non-linear, second-order reflection in order to let a new idea emerge.
- Networked thinking: a quiet cognitive revolution より引用
より具体的に言えば、拡張知能 (Augmented Intelligence) や認知拡張 (cognitive augmentation) として、人間の非線形的な思考形態を補助するような思考のためのツール (tool for thought) として着目されている。
Obsidian はアウトライナーである Dynalist の開発チームが現在開発しているマークダウン&ナレッジベースツール。
この分野は特に 2019 年頃からアメリカ等で盛り上がってきている。ObsidianやPKMに関するリンク を Hugo のサイトの方でまとめているので気になったら見てみてみてね。
PKB の種類や構成について
PKB には幾つかの特性があり、それぞれの得意分野が存在する。それが Nick Milo の次の動画で詳しくわかる。
簡単に要約すると、PKB のアプリケーションは
Collector/Databaser/Writer/Connecter の 4 つの機能の構成割合から次のように分けられる。
- Collector : Evernote
- Writer : Bear, Ulysses
- Connector Databaser : Roam Research
- Connector Writer : Obsidian
もちろん Roam や Notion といったものにはそれぞれの得意分野が存在する。例えば、Notion はチームでの wiki 作成、運用などが得意であったり、Roam はアウトライナーとしての能力があり、それぞれ素晴らしいツールとなっているので、自分にあったツールを見つけて使うのが良い。
ただ、Nick 曰く、Obsidian は Writing に的した PKM ツール (ナレッジベースかつアウトプットできる) としての能力を兼ね備えているので、ナレッジベースからそのままアウトプットをしたい場合には Obsidian はかなり役立つと思われる。
得られるメリット
Obsidian の Vault(保管庫) 内部にて Hugo や Zenn 用のローカルリポジトリを作成すれば、自分のナレッジベースとサイトやブログ、知見記事、本など すべてをマークダウンファイルで一元化させて管理することができる。
- ナレッジベースとアウトプットコンテンツの間の 情報のズレを無くす ことができる。
- 記事を公開するのにコピペする必要がなくなる。インターネット上ではレイヤーの異なるアウトプットコンテンツが全て自分のナレッジベースに統括&同期されているので 情報の重複やズレを無くすことができる。
- あらゆる情報や知識を リンク によって接続することで新たなアイデアを発見したり、知識を創造できる。
-
[[wikilink]]によって様々なノートとアウトプットされた記事をリンクすることでローカル環境においてナレッジネットワークを作成することができる。 - グラフビューによってネットワークの可視化と効率的なネットワークのナビゲーションを行うことが可能になる。
-
-
埋め込み参照 によって知識の様々なレベルでの 再利用性 が高まり、デジタルライブラリ内で 効率的に循環 させることが可能になる。
- Obsidian の埋め込み機能
![[]]や![]()を使えば学習効率や問題解決のスピードがあがる。 - ナレッジベースから高速で自分のブログの投稿や記事といったアウトプットコンテンツにアクセスし参照することができる。
- 逆にすべての記事をナレッジベースの一部として扱うことができるので、再びアイデアを発見できるかもしれない。
- Obsidian の埋め込み機能
- 一元化された環境内部で アウトプットの高速化と頻度向上が可能 になる。(可能性としてのメリットだが、少なくとも記事を書くことの壁が低くなる)
- アイデアにすらなっていないような思考状態のものから、アイデア、そこから洗練され完成した知識や知見、さらには本まで様々なレベルのものを一元化させてナレッジベース内で完結することで、スムーズにアウトプットできるようになる。
- 仮に別のツールやプラットフォームに移動する時が今後きたとしても、データはローカルのマークダウンファイルとして存在しつづけるため、ツールやプラットフォームの移動が楽になる。
- このこと自体が精神的な安心感を与えツールそのものをつかいつづけることができる。
上に列挙したメリットはそれぞれ相互に関連している。
1. 情報の重複やズレを少なくできる
『No more Copy & Paste』
Wordpress や note などで記事をつくったことがある人はわかるかもしれないが、自分の好きなエディタで記事を書いても、記事をそのまま公開することはできない。エディタからいちいち専用の web ページにコピペし直すという工程 が存在する。
何が問題かというと、記事に変更や更新があったときにその web ページから変更や更新を行う必要があるということだ。それによって、もともとのエディタで書いていた記事と実際に公開されている記事の間で情報のズレが発生することになる。もちろん、エディタで直してから再びコピペし直せばよいのではないかという話はあるが、けっこう面倒くさい。というのも見た目をリアルタイムで確認できない場合があるからだ。変更や更新をしてプレビューしたいことも多いので結局エディタでやらずに直接編集するということになってしまう。これによって公開されている記事の方がローカル環境より最新という状態になってしまう。これではナレッジベース内で再利用することに壁ができてしまう。自分のナレッジベース内の情報こそが最新状態であるという状態 が望ましい。
ところが、Hugo や Zenn などであれば cli を使ってコマンドを叩けばブラウザからローカルホストでリアルタイムのプレビューを見ることができる。これにより、プレビューを見るために web ページで編集し直して、エディタ元のオリジナルの記事とズレてしまうということをなくすことができる。常にローカルと Publish された記事の情報が同期されている、またはローカル環境の方が最新状態ということにできる。
2. リンクによるナレッジネットワークの形成
レイヤーを超えたリンキング
各アウトプットコンテンツにリンクリストを作成したり、[[wikilink]] を埋め込めばそのまま Obsidian のネットワークの構成要素として利用することが可能。インターネット上で異なるレイヤー(個人ブログとプラットフォーム) に属しているコンテンツがそのレイヤーを超えてローカル環境でネットワーク化される。
↑この記事のローカルグラフ (深度 : 1)
↑この記事のローカルグラフ (深度 : 3)
この記事の下にリンクリストを設けた。このリンクによるローカルネットワークが右のグラフビューに現れている。グラフの深度を調整することでこのノートを起点としたリンクの接続を様々なレベルで視覚化できるようになる。
ヘルプドキュメントの翻訳プロジェクト で作成したドキュメントのノードグラフとネットワーク化された一連のメモ郡↓
ナレッジベースからアウトプットコンテンツへ高速アクセス
後で説明する MOC を作成すると (要するにリンクのリスト) 高速で自分のアウトプットコンテンツにローカルでアクセスできる。
サイドバーにそのリンクリストを置いておけば、一瞬でアクセスできる。その上、プレビューのプラグインでカーソルをあわせると内容をポップアップで確認できる。
また｢検索結果をコピー｣する機能を利用すれば、リンクリストを高速で作成できる。
エイリアスによる超高速アクセス
Obsidian の YAML フロントマターにはエイリアスという項目が存在する。
例えば、この記事の YAML フロントマターには alias: [OHZフロー, OHZflow] という項目を記述している。これによって、Obsidian のどこからでも クイックスイッチャー を使ってそのエイリアス名 OHZフロー または OHZflow でこのノートを呼び出すことができる。
---
title: "Zenn & Hugo in Obsidian : OHZフローによるナレッジベースとアウトプットコンテンツの完全統括"
emoji: "💎"
type: "idea"
topics: ["zenn", "obsidian", "hugo", "PKM", "マークダウン"]
published: true
alias: [OHZフロー, OHZflow]
---
もちろん Hugo の記事にもエイリアスを設けている。これで記事のファイル名に関係なく、すぐに記事を呼び出すことができる。
---
title: Obsidian PKM Map
type: docs
alias: [pkm map, Obsidian PKM Map]
---
クイックスイッチャーを利用したエイリアスによるノートの呼び出し
3. 情報や知識の再利用による循環
Obsidian の参照機能には三段階ある (ページレベル･見出しレベル･ブロックレベル)。あらゆる自分のアウトプットとしての記事やブログのポストから参照することができる。
↑見出しレベルの埋め込み
↑左のノート (Hugo のサイト記事) の段落を トランスクルージョン で右のノートに埋め込んでいる。
4. アウトプットの高速化と頻度向上
今まで述べてきた 1~3 のメリットからあらゆる知識や情報が格納されたナレッジベースかつアウトプットコンテンツの生成環境の両方を兼ねることができるが、これのおかげで Evergreen Note を 高いクオリティで実現 できる。すべての公開されている記事がローカル環境において最新であり、インターネット上で切り分けられているあらゆるコンテンツがローカルではネットワークの構成要素として機能する。
何か記事を更新しようと思えば、ローカル環境で Obsidian を開けば、そのまますぐに書ける。
記事ではなく、未発表のアイデアにしたいならナレッジベース内のノートにかけばよい。記事と関連するならリンクすればよい。なにせローカル環境が一番最新であり、あらゆるレイヤーにあるすべての情報が存在している。
『思考の断片』から『アイデアの粒』、記事の『ドラフト』から『完成品の本』まで、あらゆるアウトプット記事とナレッジベース内のすべてのノートが並列に並んでおり、同時にネットワーク化されている。あくまで可能性としての話だが、これによりアイデアや知識の状態をスムーズにあげていくことが可能になるはずだ。
左が Hugo の記事、中央がナレッジベース内ノート、右が Zenn のこの記事。
Evergreen Notes
これによって、すべてのノートと記事そのものを高いクオリティで Evergreen Note 化することが可能になる。
Evergreen Notes とは、Andy Matuschak 氏が考案したノートテーキングの概念であり方法論。
一過性のノートによる知識やアイデアの損失を防ぐために、あらゆるノートを蓄積し、さらにそのノートに再訪して情報を追加･修正し、時間経過と共にそのアイデアや知識を成長させ、さらに有機的に別のアイデアや知識に接続させようというような考え。いくつかの原則 がある。
上で述べてきたようにナレッジベースからアウトプットへのパスを Obsidian 内の環境において整備することによってアイデアとノートの成長を促し Evergreen にすることができる。実際にやっている感覚としては『記事』を更新するのではなく、自分の『ナレッジベース内の 1 つのノート』を常に更新している感じだ。
メモのクオリティについて
ライブラリに存在するノートはナレッジベースとしてのクオリティで作成すると記事に転換する際に書き直す必要性がでてきてしまうので、効率的にアウトプットできるように日頃からクオリティやわかりやすさに気をつけてメモを行う ようにする。常にアウトプットを意識してメモをとるようにしよう。
参考記事 :
5. ツールやプラットフォームの移行のしやすさ
フレーバーが若干異なるところを除けば、すべて基本的な文法は一緒であるローカル環境のマークダウンファイルを利用している。
これは、大きなメリットとなる。というのもこれは WordPress から Hugo 等に移動する際に感じたことだが、移行はけっこう面倒だったからだ。移行ツールなどが存在するものの結局データの手直しが必要となった。幸い、自分の WordPress で作成したサイトの記事はすくなかったため長年運用しているようなサイトに比べれば比較的に楽に移行完了ができたので良かった。
可能性としては低いかもしれないが、プラットフォームなどのサーバーが突然落ちたり、記事そのものの移行ができないということはなくなる。これもローカル環境のマークダウンファイルの恩恵だ。例えば、画像の扱いを除けば、Hugo に書いた記事を Zenn にそのまま移行するなど、かなり楽だ。むしろサーバーに上げた画像のリンクから画像をレンダリングしている場合ならそのまま移行することさえできる。逆にインターネットに上げた記事をアーカイブしたい場合や Obsidian のナレッジベースの一部に戻したい場合などもファイルを移動させるだけでよい。
今後、Hugo や Zenn、ひいては Obsidian が廃れる時が来たとしても自分が時間や労力を投じたコンテンツやナレッジベースの互換性や安全性を保証することができる。(もちろんバックアップなどは適宜必要) 逆説的に、安心してそれらのツールやコミュニティを使い続けることが可能になる。
OHZ フロー
ナレッジベースとしてのデジタルライブラリとメディアとしてのポストを融合させ、Obsidian の保管庫内部から様々なレイヤーにアウトプットとしての記事をパブリッシュできるようにする。
｢Obsidian 内のナレッジベース (個人の知識のメモ)→Hugo を利用したブログやサイトのアウトプット→Zenn での知見や本としてのアウトプット｣というような具体的なツールを利用したコンテンツのフローを暫定的に｢OHZ フロー(オーズフロー)｣と名付ける。
フローのイメージ
↓ 全体のフローのイメージ図
↓ OHZ フロー(ContentsFlow) の暫定的なイメージ図。(mermaid 使って state-diagram で作成したイメージ図)
すべての流れを書くと汚くなるので省略している (イメージでつかんでほしい)。
ContentsFlow の中の Publish/Hugo/Zenn はどれかなくともよいし、別のサービスでもよい。(人それぞれ) 例えば、Gitbook などでも CLI を入れればローカル環境で執筆できるようなので、このフローの構成要素は色々と置換することができる。
ちなみに、このフローに Anki も追加して学習フローも作成する予定。
コンテンツレイヤー
OHZ フローでのコンテンツレイヤー
どのようにコンテンツを分けるか。多分個人によると思うので一例というかアイデア。コンテンツに色々なレベルを設けている (といっても Zenn はまだはじめたばかりなのでこれから...という感じになるが)。洗練度やスピードなどのレベルが異なるように コンテンツに対して各ツールと共にレイヤー分けを行う (現在は Hugo/Zenn/Publish 用にディレクトリを作成して運用している)。
- Obsidian 内のまったく公開されないノート (PrivateNoes)
- 記事のクリッピングや現在進行中のプロジェクト
- プライベートな内容を含むノート
- 勉強内容など、ここから Anki にぶっ飛ばす
- パーソナルナレッジベース内のノートをすべて管理するための構造用ノートなど
-
Obsidian Publish : 現在実験中の Digital Garden(有料)
- Obsidian 内のアイデアノートやまとめなど (個人的なものであるが公開されても良いような中途半端なもの)
- あまり人が見てもそこまで分からない
- Hugo : プラットフォームではない超個人的なサイト (無料)
- 個人的なブログ (なんでも書いて OK、好きなこと書き放題)
- ある程度まとまったことについて書いている (ある程度完成している)
- Zenn : デベロッパー用のナレッジベースプラットフォーム (無料)
- コードや技術的な解決策などのコンテンツ (コンテンツのドメインが限定的: note にあるようなどんなテーマでも書けるというわけではない)
- 同様に技術的なことについてかなり詳しくなったことについて本としてまとめてアウトプット
- プラットフォーム用に内容をある程度調整する必要がある
ここまで切り分けると面倒なのではというツッコミはあるかもしれない笑
最終的なコンテンツが｢Zenn の本｣というような扱いになるかもしれない。
Maggie 氏の図のようのインターネットのコンテンツレイヤーのレベルを意識している。
- スピード
- コミュニケーション
- ドメイン
- プライバシー
- 洗練度
...etc
Zenn 内部のコンテンツレイヤー
Zenn 内部でもレイヤーがある
- Scrap : 現在進行中の問題解決やアイデア等 (obsidian 内ではなく zenn の web ページで編集している)
- 編集可能なツイートのイメージ、かなり気軽に書くことができる (ショート・タームのフローかつストック)
- 他の人とのコラボレーションや会話が可能
- 最終的にはマークダウン出力をして Obsidian を介して Zenn 用のリポジトリから記事として再編成する
- Article : まとまった記事 (1 つのトピックで完結)
- Book : 記事の集合による特定のテーマについての最終完成品
ここらへんについてはまだしばらく試行錯誤していくことになると思う。
ノートの転送
コマンドパレットからコマンド Move to other folder(ファイルを別のフォルダへ移動) を使えば、別のディレクトリへと移動 (転送) できる。
右上の option からも移動することが可能
これと [[wikilinks]] と合わせれば、そのノートのネットワーク構造を維持したままの状態で自由にフォルダ移動させることができるようになる。(フォルダを移動してデータの階層構造が変化してもネットワークの構造は変わらない)
つまり、好きなときにあらゆるノートを簡単に Hugo や Zenn の (内容は別として) 記事に昇華させることができる。ナレッジベース内のネットワークはそのままにノートを Zenn や Hugo のディレクトリに移動させるだけだ。
[[wikilinks]] ネットワークを利用することで、デジタルライブラリ内で、あらゆるノートを流動的に移動することが可能になる。
PDF データとして完成品をライブラリから切り離す
Obsidian では PDF として出力機能が搭載されており、埋め込み機能や URL によるリンクで表示している画像、コードハイライトなどを含めてまとめて出力することが可能。
↑この記事を PDF として出力したもの
これにより更新可能な記事としてではなく、ライブラリから特定の時点で切り離した完成品として出力することも可能になる。
(-->[[コンテンツの継承システム]]"2021-01-04" に分岐)
ノート管理とネットワーク形成
LYT : Linking Your Thinking
具体的に Obsidian 内にてどう管理するのか？個人的に実践している方法を説明すると、Nick Milo の LYTフレームワークにおけるMOC を利用して各ノートへのリンクを 1 つのノートにリストとしてまとめることによってそれぞれのノートへのアクセスポイントを確保するようにしている (要するに各ノートへのルートを整備している)。
[[wikilink]] によるネットワーク形成を行うと、フォルダシステムによる階層的な現実のデータ構造だけでなく、ネットワーク構造が出現するのでどのようにネットワークを形成していくかが重要になってくる。
LYT は Idea Emergence(アイデアの創発) のための方法論でもある。(→[[創発とは]])
創発（そうはつ、英語：emergence）とは、部分の性質の単純な総和にとどまらない性質が、全体として現れることである。局所的な複数の相互作用が複雑に組織化することで、個別の要素の振る舞いからは予測できないようなシステムが構成される。
- 創発 - Wikipedia より引用
LYT の具体的な話は以下の Nick の twitter 上のスレッドを追ってほしい。
(ちなみに LYT は Obsidian 公式もおすすめしている方法論、というか LYT に最適化するように開発しているところもある)
↓Nick が開いている LYT のワークショップのサイト
ワークショップを受けなくても次の Nick の Publish からかなり詳しく分かるので一読をおすすめする。
LYT は上で紹介したフローイメージの Network のセクションが相当する。
LYT におけるネットワーク形成方法のイメージはネットワークの大きな構造として上の図の Decentralized(非中央集権型) を中心とするが、Dsitributed(分散型) のようにあらゆるノード同士で結ぶことも可能、というような構造をつくる。実際に作成する際にはどのようにでもネットワークを作ることが可能 (どのノートからどのノートにリンクしてもよい) なので、かなり流動的な構造になる。(追加や削除はいつでもしてよい) 時間経過で構造がすこしずつ変動してくる。
LYT はノートのスケーリングを考えた方法論なので、最初は何に役立つか分かりづらいが、ノート数が時間経過とともに膨大になった際に有効性が顕著になってくる。(例えばノート数が 5000 枚ぐらいの数になったときにどうやってコントロールすればよいかという方法論)
OHZ フローについてのまとめなので、ここでは深くは説明しないが、簡単に LYT にでてくる概念を紹介する。
- Home Note : Domain ごとの MOC の中心となるハブ。ナビゲーション用のハブとなる構造ノート。
- Obsidian の Vault のアクセスポイントであり、ここを起点としてすべてのノートにアクセスすることができる。
- 主に大きな MOC にアクセスするための
[[wikilink]]によるリンクのインデックスリストとなる。
- MOC : Map of Contents
-
[[wikilink]]によるリンクのインデックスリスト - ここを起点に様々なノートにフォルダによる階層構造をとびこえてアクセスできる。
-
- Domain MOC : 大きな概念を包括するような MOC。(これは自分用の概念で MOC を扱いやすくした)
- Topic MOC : 特定のテーマやトピックについての MOC。様々な AtomicNote へのリンクをリストアップする。(これは自分用の概念で MOC を扱いやすくした)
- Atomic Note : それぞれのノートであり、各マークダウンファイル。EvergreenNote や Zettelkaste にでてくる概念。
ネットワークの形成の仕方は人それぞれなので、上の LYT などの方法は 1 つの参考例として考えてもらいたい。また、それぞれのノートから自由に別のノートにリンクを作成するので、実際に出来上がるネットワークはかなり自由で流動的なものとなる。
↓ Obsidian 公式 twitter で紹介しているグラフビューの例
やり方
まずは Git を導入して、Github の自分のアカウントに Hugo と Zenn 用の空リポジトリを作成し、Obsidian の Vault 内部に専用ディレクトリを作成しそこにリポジトリを両方ともクローンする。
Hugo の導入方法は 公式ドキュメント を参照。
Zenn CLI の導入方法についても 公式ドキュメント を参照。
実際のディレクトリ構造
ObsidianVaultName
└── Subvalut
├── Zenn-repo
└── Hugo-repo
適当なディレクトリにリポジトリを用意するだけです。もしくは既存の Hugo 用のディレクトリ等を Obsidian の Vault に移動させてくるなど。
双方ともターミナルにてそれぞれのコマンドを叩いてドキュメント等を用意する、もしくは Obsidian でドキュメントを作成する。記事等が完成したら git push してリモートリポジトリに飛ばす。Hugo なら Netlify などのホスティングサービスを利用すれば自動的にビルドしサイト上にデプロイされる。
複数リポジトリでの管理
Obsidian の Vautl(ライブラリ自体) をバックアップやバージョン管理するために git を使ってリポジトリ管理する場合には少し複雑になる。
Hugo や Zenn のディレクトリを入れてあるフォルダ (自分の場合だと SubVault という名前のフォルダ) を git の追跡から外すように、ライブラリ直下にある .gitignore ファイルに以下を追記して、別のプライベートリポジトリで管理できるようにする。
SubVault/Hugo-repo/
SubVault/Zenn-repo/
- Obsidia の Vault 全体 → Vautl 専用のプライベートリポジトリで管理
- Vautl 内の SubVautl に存在する Hugo のディレクトリ → Hugo 用プライベートリポジトリで管理
- Vautl 内の SubVautl に存在する Zenn のディレクトリ → Zenn 用プライベートリポジトリで管理
ちなみに Obsidian Sync という有料の同期サービスが公式から出されているので、mobile 版登場まで git で管理する予定だ (Sync では公式のバージョン管理機能や特定フォルダやファイル拡張子の除外も可能)。
obsidian-git で push 自動化
git のセットアップが終わったら、obsidian-git のプラグインを利用すると自動的に設定した時間ごとに remote repository に git push してバックアップをとることができるようになる。
もちろんコマンドを使うことで手動でも push してバックアップをとることができる。
obsidian における git のセットアップについては Bryan Jenks の記事が詳しい。
利用上の注意点
パスの更新
Obsidian 内部にてディレクトリを移動させてしまうと設定によっては相対パスなどが更新されてしまうので、Obsidian 内部では Hugo や Zenn のディレクトリの移動はしないようにする。
埋め込みの扱い
![[]] や ![]() などによる記事の埋め込みなどは、ライブラリ内部でしか役にたたず、Zenn や Hugo などでの記事では利用できないので、注意する必要がある。
git によるバージョン管理での複雑化
git によるバージョン管理を行う際に、特定のコミットなどに戻した際に、Zenn や Hugo の記事に貼ってあるライブラリ内部の他のノート名の変更などがあればリンクや埋め込みなどが更新される前の状態にもどることになるので、再びリンクし直すことになる。
Zenn や Hugo でリンクを貼る場合には気をつけて運用する必要がある。
現時点での課題
課題 1: 画像の扱い
Hugo では相対パスによる画像表示が可能だが、ページバンドルにする必要がある。
特に Hugo では相対パスによる画像表示を利用することで、マークダウンアプリで記事を触る際に画像をプレビューできる。むしろ、相対パスを利用しないと画像を確認できない。参考 → Relative path for markdown editor preview - support - HUGO
content
└── section1
└── mypost
├── img1.png
└── index.md
Hugo のディレクトリはこんな感じにする↑
Zenn の場合には Github に画像を上げたり、Zenn の管理ページから画像をアップロードする必要がある。現在、Zenn では相対パスによる画像表示をサポートしてないのでそこは改善してほしい。
課題 2: フレーバーの違い
Obsidian/Hugo/Zenn ではマークダウンにそれぞれ独自のフレーバーがある。Obsidian での再利用を考えるとなるべく独自フレーバーを使わないようにするなど気をつけなくてはならなくなる。(ここは運用によって裁量が決まってくるのでバランス良く考えたほうがよい)
例えば、Hugo のショートコードや Zenn のコンテンツ埋め込み用のコードなど。逆に Obsidian の [[wikilink]] は Hugo や Zenn でのデプロイされたコンテンツでは認識できないのでリンクを切ることができる。
課題 3: フォルダ除外
Zenn や Hugo を保管庫にいれると node modules などいらないものがグラフビューなどに表示されたりする。
これを解決する一番簡単な方法は画像のようにグラフビューで除外用のコードを入れてあげることだ。また、フォルダが多くなるため｢ノートの転送｣で紹介した Move file to another folder(ファイルを別のフォルダに移動) コマンドでもフォルダ名を打つと若干遅くなる
公式のフォルダ除外機能の開発が待たれる。
課題 4: OTA プラグイン併用
次の記事 Obsidian_to_Ankiの使い方 : ZettelkastenとSRSを組み合わせる で紹介する Obsidian_to_Anki のプラグインとの併用でカスタムシンタックスを利用すると意図しない ID の挿入がされる。
思考収束の盲点
ここまで Obsidian の凄さや OHZ フローなどアウトプットの効率化の方法を紹介してきた。水をさすようで悪いが、気をつけてほしいことは Obsidian や Roam などのツールを使っても｢アウトプットの難しさそのものが変わるわけではない｣ということだ。｢思考収束の難しさ｣に関しては滝林さんの記事で語られている。
ツールはツール。思考を収束したりアウトプットを作成するのは結局個人の問題に帰属する。しかし、ナレッジベースから直接記事をアウトプットするという姿勢や方法 (ナレッジベースからアウトプットへのルートが確実に整備された状態) は (アウトプットそのものの質を向上させるわけではないが)、アウトプットするための壁を低くしたり、より高い頻度で更新することでアウトプットの質が 結果として向上 する。こういうカラクリだと個人的には思う。
偉そうに言っているが、私も実際にこのフローをやってみてアウトプットには苦労している。結局 note だろうが zenn だろうが、hugo だろうがどのプラットフォームでアウトプットしようが｢アウトプットは容易ではない｣ということが理解できた。ただ一言加えるなら、Wordpress でブログを書いていたときよりも断然｢楽しい｣。Obsidian は使っていて楽しい (Zenn も楽しい)。これにつきる。そういった楽しさもアウトプットの頻度や質を結果としてたかめてくれるはずだ。
その他の運用
データとアプリケーション
vscode との受け渡し (データはそのままで markdown ファイルを触るアプリケーションを変える) 方法は vscode の方に次のような PKM 用のプラグインをどれか入れてやる。
これらのプラグインを入れると [[wikilink]] 形式のリンクを認識できるようになるので Obsidian の vault 内のデータを vscode で開いても同じように認識でき、vscode でもリンクを作成、またプレビューなどを行うことができるようになる。つまりデータに対して vscode と obsidian の能力を両方そのまま使うことができる。
ちなみに現在は vscode-memo を利用している。
vim や vscode や Obsidian 等、マークダウンファイルは必要に応じて触るアプリケーションを変えることができるのがよい。
↑ Obsidian と vim と vscode で同時に開いた状態。
Web ページのクリッピング
Evernote のようにクリッピングしたい場合には、Obsidian のモデレーターチームの一人である death.au が開発した次の Chrome アドオンを利用するとよい。
ただし、クリッピングしすぎると ライブラリの汚染(ノイズ増加)になる ので次の様のある程度ルールを設けて注意して使っている (とは言っても大抵は柔軟に活用している)。
- 本当に重要なものだけクリップする
- クリップする必要のないものはブラウザのブックマークで十分
- 一部分だけクリップし、ソースを必ず記述する
YAML フロントマター
Obsidian,Hugo,Zenn のいずれも YAML フロントマターを利用することができる。Obsidian の Template プラグインでそれぞれ YAML フロントマターのテンプレートを作成しておくと簡単に作成することができる。
categories:
- Development
- VIM
date: "2012-04-06"
description: spf13-vim is a cross platform distribution of vim plugins and resources
for Vim.
slug: spf13-vim-3-0-release-and-new-website
tags:
- .vimrc
- plugins
- spf13-vim
- vim
title: spf13-vim 3.0 release and new website
darft: ture
alias: [hugoのyaml]
title: "Zenn & Hugo in Obsidian : OHZフローによるナレッジベースとアウトプットコンテンツの完全統括"
emoji: "💎"
type: "idea"
topics: ["zenn", "obsidian", "hugo", "PKM", "マークダウン"]
published: true
alias: [OHZフロー, OHZflow, zennのyaml]
date: 2020-12-07
tags: [obsidian, zenn, hugo]
alias: [ohzフロー, obsidianのyaml]
alias は Zenn や Hugo でも記述しても特に問題がなかったのでどのフロントマターでも利用できる。
Discussion