Gistを使い始めて気がついた点をメモした。 Gistはこのようなメモや短いコードをバージョン管理しながら公開するのに便利。
特にこのメモでは、画像を同一ディレクトリに置いて、 それGFMファイル内に挿入する方法を解説。
このメモにはgitコマンドの使い方の解説はない。 このメモは随時更新される予定。 Tipsなどのコメントを乞う。
例えば git clone https://gist.github.com/9580883.git HowToGist
もしくは git clone [email protected]:9580883.git HowToGist
とすればHowToGist/というディレクトリが作られ、
その中に!HowToGist.mdなどいくつかのファイルと.git/ディレクトリがcloneされる。
Gistのwebエディタ Ace はまだ日本語の編集に少し難があるので、Gistの文章は手もとで編集してgit pushするのが便利である。
１つのエントリーには１つのディレクトリが割り当てられ、そこに複数のファイルを置くことができる。
複数のファイルの表示順序は現在はASCII順のようである。
よって、１番上に表示させたいファイル名は'!'で始める。例: !HowToGist.md
.gitignoreも置くことができる。
この!HowToGist.mdのように、
GitHub Flavored Markdown (GFM)
で書かれたファイルはHTMLに変換されて表示される。
意味のあるファイル名を持ったGFMファイルが先頭に置かれてうまくHTML表示されるには、
ディレクトリ内のすべてのファイル名を工夫する必要がある。
git add vietnam.jpgで後から画像を置くこともできる。
その画像が200kB以下なら https://gist.github.com/t-nissie/9580883/raw/vietnam.jpg
とgistのURLと画像のファイル名との間にraw/を挿入することで参照することができる。
ファイルサイズが大きいすぎると参照できないらしい。
図: GFM文章の中に画像を挿入した例。ベトナムみやげのクマのぬいぐるみの写真。
ブログなどにGistの内容を貼り付けるには、Gistの最上部でEmbedを選択して得られる
<script src="https://gist.github.com/t-nissie/021f09aa327f02d0a710.js"></script>
などを使う。たとえば https://gist.github.com/t-nissie/021f09aa327f02d0a710 を貼り付けてみると
<script src="https://gist.github.com/t-nissie/021f09aa327f02d0a710.js"></script>となる。（Gistでは表示されない。）
Gistを作るとき、それをSecret Gistと指定することもできる。 Secret GistのURLを友人に送ればそのGist文書を友人間で共有できる。 Secret GistはGoogleなどのサーチエンジンの対象外にはなるが、 閲覧にパスワードが必要というわけではない。
例えば、学術論文のLaTeXソースコードや図のPDFファイルをSecret Gistに置いて、 それらを共著者と共有すると便利である。 編集の履歴が残るので、論文の正当性の証明の１つとして使えるかもしれない。
Secret GistをPublicにするには [Edit]ボタンを押すと出てくる [Make Public]ボタンを押せばよい。
あなたがあなたの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 を通して報告すれば、数時間以内に直してもらえる。
