2024-08-24 - 個人的になんとなく避けがちだった GitHub の Wiki 、そのまんま git 管理できるの良さげでは

[kachick]

今更気づいたけど GitHub の wiki はエクスポート云々考えるまでもなくデフォルトで git 管理下に markdown がぽこぽこ置かれるというシンプル具合なので、結構使いやすい気もしてきた。

例えば Helix の wiki とか https://github.com/helix-editor/helix/wiki 、 https://github.com/helix-editor/helix.wiki.git をクローンするだけでgit管理出来るの結構体験が良い

wiki フォーマットにあんまなれてないというのと、フリーアカウント且つプライベートリポジトリでの制限はちょっとネックだけれど・・・

というのを、 Zettelkasten 的な事をかんたんに始めたいなーと思ってるときにおぉとなった。

kachick/dotfiles#729, kachick/dotfiles#748

何が良いかというと基本的にローカルで編集できるようにするとその手のはWebUI連携は別途考えないとみたいなことが多いんだけど、これフォーマットがプレーンなMarkdownみたいなので保存先やらWebUIが欲しいときだけGitHub Wikiに押し付けると考えること減らせるのではという
ただそれだとローカルで取り扱うMarkdownもプレーンなままに保つ必要があるから、https://github.com/zk-org/zk みたいに YAML header が含まれる事を期待されると相性が悪いかもしんない

[kachick]

ちょっと試してみた限り .md を追加すれば普通に表示されるし、 .txt とかだと何も表出しないがgit管理はされつづけている。
リポジトリ本体に assets とか置いてドキュメント用のスクショファイルとか管理するのgitの履歴が無駄に肥大化しそうでちょっと抵抗あるときとかこれを使ったりできないか(脱線)

[kachick]

https://github.com/gollum/gollum/wiki

この gollumというプロジェクトを以前はそのまま使ってたらしいけど、今はフォーク状態なのか完全に同じというわけではないらしい

[kachick]

とりあえず GitHub Wiki の内容を gollum でサーブするといい感じにレンダリングしてくれるのでこれでいい気もするな・・・
irb で Markdown にクエリ的なのかけられるし、データの一括整形必要になってもテキストそのまま扱うより若干楽になるかもしんない

[kachick]

そんな gollum を closure で再実装したらしいsmeagolというのがあるんだけど、その中でまさに自分がやろうと思ってた「常時pandoc変換からstatic site generatorに引き回す」案が否定されとった。先人の知恵〜

https://github.com/journeyman-cc/smeagol/blob/d22bd72f5a55da9b728cf51719d94edd891bd500/README.md?plain=1#L6

[kachick]

git + wiki + pandoc 的なのをまさに pandoc の作者が作っていた https://github.com/jgm/gitit

少し触った限り、正直使いやすさだけ見ると gollum の方が楽な感じ