Gistを使い始めて気がついた点をメモした。 Gistはこのようなメモや短いコードをバージョン管理しながら公開するのに便利。
特にこのメモでは、画像を同一ディレクトリに置いて、 それGFMファイル内に挿入する方法を解説。
このメモにはgitコマンドの使い方の解説はない。 このメモは随時更新される予定。 Tipsなどのコメントを乞う。
例えば git clone https://gist.github.com/9580883.git HowToGist
もしくは git clone git@gist.github.com:9580883.git HowToGist
とすればHowToGistというディレクトリが作られ、
その中にHowToGist.mdなどいくつかのファイルがcloneされる。
Gistのwebエディタ Ace は特に日本語の編集に難があるので、Gistの文章は手もとで編集してgit pushするのが便利である。
１つのエントリーには１つのディレクトリが割り当てられ、そこに複数のファイルを置くことができる。 複数のファイルの表示順序は ASCIIbetical order との こと。
Gistに.gitignoreを置くと見せたいファイルより ASCIIbetical order で前にきてしまって、.gitignoreが前面に出てきてしまう。 Gist用の.gitignoreはローカルだけに置くことにする。 その場合.gitignoreの中に.gitignoreも書く。 例えば https://gist.github.com/t-nissie/9771048 のための.gitignoreはこんなかんじ:
*.dSYM
*.log
*.o
crd2enex
science.crd
science.enex
.gitignore
このHowToGist.mdのように、 GitHub Flavored Markdown (GFM) で書かれたファイルはHTMLに変換されて表示される。 意味のあるファイル名を持ったGFMファイルが先頭に置かれてうまくHTML表示されるには、 ディレクトリ内のすべてのファイル名を工夫する必要がある。
手もとでGFMファイルをHTMLファイルに変換するには次に挙げるようないくつかの方法がある。
- Ruby Gemのgithub-markdownを用いる
- 公式APIを使う
- Firefox add-on GFM Viewer
- grip
画像ファイルをドラッグ・アンド・ドロップでGistにアップロードしたり、
selecting themをクリックしてアップロードすることもできる。
また、git add vietnam.jpgで後から画像を置くこともできる。
その画像は http://bl.ocks.org/ を使って http://bl.ocks.org/t-nissie/raw/9580883/vietnam.jpg と参照することができる。
図: http://bl.ocks.org/ を使ってGFM文章の中に画像を挿入した例。ベトナムみやげのクマのぬいぐるみの写真。
Gistを作るとき、それをSecret Gistと指定することもできる。 Secret GistのURLを友人に送ればそのGist文書を友人間で共有できる。 Secret GistはGoogleなどのサーチエンジンの対象外にはなるが、 閲覧にパスワードが必要というわけではない。 Secret Gistは自分のGistのページで金色の枠が付いて表示される。
あなたがあなたのGistにアクセスして "Whoops. We seem to have missed the gist of that gist you were looking for." 表示されたら、あなたはGitHubにspammer/spammyと誤認されている。 GitHubにアクセスして "One of our mostly harmless robots seems to think you are not a human." と赤で表示される場合も同様に誤認されている。
焦らずに https://github.com/contact を通して報告すれば、数時間以内に直してもらえる。
