LoginSignup
4
4

More than 5 years have passed since last update.

GitHubのWikiをローカルで参照する方法

Posted at

ことはじめ

「そうだ!Androidの勉強をしよう!Androidの勉強といえばmixiがGitHubでテキスト?を公開してたな。」

………

「うう…勉強しようにも移動中にPCは開けても通信回線がないからWikiが見れないよう……」

そんな貧乏臭い発想が発端です。

1.Wikiに上がっているファイルをチェックアウトする。

GitHubではWikiもGitで管理されているので、普通にgit cloneできるようです。
やり方はプロジェクト名の最後を.wikiにするだけ。
例)
git clone https://github.com/mixi-inc/AndroidTraining.wiki

2.Wikiで使用されているリソース(画像系のファイル)をチェックアウトする。(もしあれば)

Wikiで画像など使われている場合はそれもローカルで表示するためにチェックアウトしておきます。

例)
mixiはリソースファイルもGitHubにあげてくれているのでこれをチェックアウトします。これは本体のリポジトリの方にあがっているので、普通にリポジトリをチェックアウトします。
git clone https://github.com/mixi-inc/AndroidTraining.git

3.チェックアウトしたWikiの参照パスを書き換える。

前の手順で画像をチェックアウトした場合は、Markdownに記載されている画像への参照パスをチェックアウトした先へ修正しておきます。
(もしかしたらちゃんとブランチ切って参照パスを書き換えたほうがいいかもね!)
例)
mixiの場合は以下みたいな感じのURLが一杯記載されてるはずなので、相対パスに書き換えちゃいます。
https://raw.github.com/mixi-inc/AndroidTraining/master/docs/resources/images/01-01/system-architecture.jpg

../AndroidTraining/docs/resources/images/01-01/system-architecture.jpg

4.ビューアでMarkdownファイルを参照して完成!

最後にチェックアウトしたMarkdownファイルをMarkdownエディタやらビューアで閲覧すれば良いだけです。
今回は完全に閲覧したいだけなので、私はChromeに以下の拡張を入れて閲覧してます。
相対パスの画像ファイルもちゃんと表示してくれるのが素敵
Markdown Preview Plus

以上です。
こんなのmixiのあのテキスト?以外になんの役に立つのかわからないけど、Markdown Preview Plusの使い勝手が良かったので宣伝したくて書きました。

4
4
0

Register as a new user and use Qiita more conveniently

  1. You get articles that match your needs
  2. You can efficiently read back useful information
  3. You can use dark theme
What you can do with signing up
4
4