トマシープが学ぶ

Unity/VR/AR/デザイン好きのミーハー 記事内容は自分用のメモです

GithubのWiki

ソフトの使い方をドキュメント化するにあたってWikiを書く

Githubwiki

Githubwikiはてなブログみたいに上の方にGUIで、太字とかリンク貼ったりできる!

f:id:bibinbaleo:20200110183936p:plain

こんな感じ

f:id:bibinbaleo:20200110183955p:plain

Markdown以外も選べる

f:id:bibinbaleo:20200110183942p:plain

Wikiをクローンしたらページごとにmdファイルになっていて、ローカルから変更のプッシュもできる

画像

画像挿入がマジでめんどくさい。どこかにアップしてリンクをはるか、ローカルにwikiをクローンしてフォルダに画像入れてそのパスを書く。

wikiとして独立性を保つためにローカルで画像追加形式にした。

Imagesフォルダを作ってその中に画像を入れる。

![](Images/WikiImagePath.png)

こんな感じに書いたら表示される。

qiita.com

VSCodeでローカルで開いて編集したほうが、すぐ画像のプレビューも見れるし楽な気がする。

ということで最近は基本ローカルで作業している。

サイドバー

* ページ名でリンクされる。特殊な記法?

howpon.com

Unityプロジェクトのドキュメント化にあたって参考になるもの

seed.online

clustervr.gitbook.io

vrm.dev

github.com