category

VSCode を使って Github の Wiki をローカルで編集・管理する

2020-06-20

Github のリポジトリで使える wiki 。最近使っていなかったのだけど、使う機会があったので色々調整してみた。

とりあえずクローンできること自体知らなかったので、clone して手元で編集したりとできるようになった。

GitHubのWikiに画像を貼付ける際にちょっと迷ったのでメモ。 - Qiita
https://qiita.com/jollyjoester...

画像を入れたいときどうするかなぁと思っていたところもあるので、これで画像の話も解決できそうでよかった。

VSCode で Markdown を編集する

Markdown ファイルを何で編集するかなぁということで、リポジトリ管理だし、コードと同じ感じで VSCode で管理する方向で進めてみる。
今回どこまで行くかは不明だけど、 Git まわりも VSCode で確認等していこうと思っているので、、、

そもそも VSCode で Markdown を書いたことがなかった気がする。
デフォルトでプレビューもできるようで。

編集したら commit, push で Github 上の Wiki にも反映される。

Markdown 編集機能を拡張する

あとは他のよくある Markdown 対応エディタみたいに、リストの記号をつけて編集したら次もリストになってくれる、とかそういうのがあれば良さそうかな、ということで Markdown All in One を入れてみた。

Markdown All in One - Visual Studio Marketplace
https://marketplace.visualstud...

この拡張自体が多機能な拡張のようなのでできることは色々ある様子。

目次もつけられた

保存すると自動で目次もアップデートされる。

これは便利だなー。
Github 上でみてみても特に問題なかった。

仕事で使うドキュメントは基本的に共有前提で考えてるから、ローカルで編集することはなくて、 Google Docs だったり Paper だったりで書くことが多いのだけど。
最近はどちらかと言うと Google Docs の方が色々考えると便利かなぁと言う気がしつつ。
Paper の画像まわりの扱いがあまり好きになれないと言うところもあるかもしれない。Markdown で書けて便利なんだけど。

Wiki の階層化

手元で管理できるなら階層つけて Markdown おいておけば階層構造にできるのかな、、、
それは後で試してみよう。
サイドメニューは編集できるっぽいけど。

GitHub Wikiの使い方 – サイドバーを編集する方法【階層表示も】 | Howpon[ハウポン]
https://howpon.com/8514

プロジェクトによってツールは色々変わってくるから、都度都度あわせながら、効率的に編集できるようにしていくのが良さそうだなぁ。

あとは画像を入れるとかを試しておこう。

参考