Githubには様々なサービスがありますが、一般的にGithubと言えば
「プログラマーやエンジニアの人が使うもの」
といったイメージがあるかと思います。
確かにGithubはプログラムコードを管理するのに向いているサービスであるため、エンジニア界隈では当たり前のものになっています。
ですが、このGithubサービスの一つにGistというものがあり、これは超手軽に一ファイル単位でGit管理(ファイル作成、修正、差分確認など)できるサービスになります。
今回はGistを使えるまでに必要なGithubアカウント作成、Gistの基本的操作方法、私の思うGistの便利な使い方を紹介してみたいと思います。
少しでも誰かの参考になれば幸いです♫
Githubアカウントの取得
まずGithubトップページの右上にある「Sign up」をクリックし、アカウント作成ページへ行きます。
Sign up用の入力フォームになりますので、作成したいアカウント情報を入力し「Create an account」で次へ進みます。
ここはプラン選択画面になりますが、今回は無料プランにします。
有料プランと無料プランの違い
因みに以前までは無料プランだとGithubのプライベートリポジトリを3つまでしか利用できなかったのですが、現在では無料プランでも無制限に利用できるようです。
- collaborators(同じリポジトリを共有できる人)の人数が無料プランだと3人まで、有料プランだと無制限になる。
- 有料プランだとAdvanced tools and insights(高度なツールと洞察)が使えるようです。これはGithubWikiであったりAPIなど、リポジトリごとに他のサービスと連携できる機能が豊富に使えるようです。
最後は、このGithubアカウントをどのように使っていくか的なアンケートになるので、適宜に入力して「Submit」でアカウント作成を完了します。
後、この間に登録メールアドレスに「[GitHub] Please verify your email address.」というタイトルで、所有者確認メールが届いていると思いますので、メール本文にある「Verify email address」をクリックして所有者確認をしましょう。
Gistの基本的操作方法
さきほどのメールアドレス所有者確認を行った先のページか、Githubのマイページの右上から「New gist」をクリックしましょう。
Gistで新規ページ作成
新規Gist作成ページになるのですが、入力欄は下記のみになっているので、シンプルで分かりやすいですね。
- ディスクリプション(説明)
- ファイル名
- 本文
後インデントの文字数や、インデントをスペースにするかTabにするかなど少しだけ調整できます。
では試しにこの記事を登録してみようと思いますが、登録時に「Create secret gist」と「Create public gist」があります。
「Create secret gist」とは
こちらはプライベートページと勘違いしている人が多いようですが、そうではありません!
作成後のページURLを知っている人であれば全ての人が見ることができるページになります。
URLもハッシュ化された固有のものになり、誰もがこのページにたどり着ける訳ではないので基本的には隠されたページではありますが。
「Create public gist」とは
こちらは完全な公開状態のページになります。
Githubでの公開状態とは、私のアカウントページにアクセスした場合に、一覧に表示されることを指します。
そのため、「Create public gist」で作成したページは、私のアカウントページに来た人全員が見ようと思ったら見れることになります。
今回はsecretモードで作成しました。
私のGist一覧ページになります。
因みに別アカウントから見た場合はsecretモードで作成しているので見えていません!
Gistページの編集、リビジョン(差分)確認
さきほど作成したGistページの右上にある「Edit」をクリックすると編集ページになります。
今回は試しにファイル名、ディスクリプション、本文の全てを編集してみようと思います。
編集が終わったらページ右下にある「Update secret gist」をクリックして編集を終了します。
編集が終わったら、ファイル名の下辺りに「Code」と「Revisions」タブがあると思うので、「Revisions」をクリックしてみてください。
するとファイル名の変更内容、本文の変更箇所、内容が分かりやすく表示されるかと思います。
ディスクリプション(説明)も変更はされていますが、差分の確認はできないようですね。
本文に関しては「-」部分(背景が赤)が元の文章になり、「+」部分(背景が緑)が編集後のものを指しています。
Gistページの削除方法
Gistページの削除は簡単で、ページ右上にある「Delete」をクリックすると、ページ上部に確認ダイアログが出るので、それを「OK」にすれば削除完了になります。
Gistの便利な使い方まとめ
私がGistを使う場合は、一時的に誰かとファイルを共有したい時に使うのですが、単純にファイル内容だけを確認してもらい、その感想などをコメントでもらったりしています。
Gistのsecretモードで共有したファイルはGoogleにインデックス登録もされないので、ある程度は安心ですが、一応URLを知っている人だと見ることは可能になるため共有が終わったら削除するようにはしています。
その他に便利だと思った使い方が、私はアフィリエイトサイトなども運用しており、その記事作成は外部ライターさんにお願いすることが多いです。
その場合、執筆頂いた納品ファイルを確認し、誤字脱字や表現に問題がないかなど検収作業を行うのですが、単体だけの依頼ですと問題ありません。
ですが、継続依頼をする場合などはライターさんに自分の修正内容などを共有しておいた方が、お互いの意思疎通ができるため次回の納品物のクオリティーが上がったり、自分の求めた内容に近いものが少ない手間で納品されるようになります。
この修正内容の共有にGistを使うことが多いです。
使い方としては先ほどと同じように、まずは納品頂いた文章をそのままGistに登録します。
次に、ローカルファイルなど自分で編集した後の文章を登録済みのGistで「Edit」更新します。
すると先ほどのRevision(差分)が確認できるようになるので、その差分ごとに修正した理由などをコメントとして残します。
因みに、Revisionページの修正した箇所の行番号をクリックするとURLが多少変わります。
行番号をクリックした後のURLは、クリックした行番号に紐付けられたリンクURLになりますので、これをコメント時に貼り付けすれば、修正箇所とその理由を明確にコメントで共有することができるということです。
以上が私の便利なGistの使い方になります。
このおかげで今やり取りさせて頂いているライターさんは私の依頼した内容以上のものを納品頂けるようになっており、本当に助かっています。
もちろん他にも便利な使い方はあると思いますので、ぜひ皆さんもお気軽にGistを利用してみてはいかがでしょうか!