## はじめに [[Obsidian]]を使えばLinkを意識した[[ドキュメンテーション]]を作ることはできる。しかし、プロジェクトで開発するうえではいくつか問題がある。 - 全員に[[Obsidian]]をインストールしてもらう必要がある - [[Obsidian Publish]]を使わなければ有意義な共有はできない [[Markdown]]というフォーマットこそロックインされないものの、便利に使おうとした場合にはある程度ロックされてしまうという話だ。 ## 解決策 ### 書く側 [[VSCode]]とその拡張[[Markdown Memo]]を使う。[[VSCode]]はデファクトスタンダードと言えるエディタであるため抵抗を感じる人は少ない。そして[[Markdown Memo]]を使うと、[[Obsidian]]のようなLink中心の[[ドキュメンテーション]]作成が楽になる。具体的には.. - `[[`で補完できる - 双方向renameできる ([[Obsidian]]はv0.10では単方向なのに!) - BacklinkもOK 加えて[[VSCode]]のエコシステムをすべて使える😄 ### 読む側 閲覧者に[[VSCode]]と[[Markdown Memo]]を使ってもらうのは言うまでもなくナンセンスだ。そこで[[docsify]]と[[docsify-wikilink]]を使う。 これで以下のようなwikiリンクをブラウザで認識するようになる。 ``` [[Filename]] ``` ## ポイント plaintextのままでもwikiリンクを自然に見せ、執筆コストを減らすために以下を守る。 - ディレクトリ階層はフラット - ファイルの意味合いを分けたい場合は短いprefixをつける - 閲覧用の構成は`_sidebar.md`に[[MOC]]として記載する - ファイル名は適した言語 (無条件に英語ではなく) - [[VSCode]]ではドキュメントルートディレクトリをrootとしてプロジェクトを開く - 未定義言語をファイル化するときにスムーズだから この辺は[[LYT]]や[[Evergreen Notes]]の概念と同じ。 ## ローカル確認 プロジェクトルートにて、同じ[[Node.js]]のpackageである[[docsify cli]]を使う。設定は[[docsify cli#設定]]を参照。 ## デプロイ ドキュメントルートディレクトリ配下をデプロイする。