1
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?

今さら聞けないGitHub Gistの使い方|コードの保存・共有・履歴管理まで

1
Posted at

今さら聞けないGitHub Gistの使い方|コードの保存・共有・履歴管理まで

作成日:2026年10月19日
スクランブル研究所|プログラミングラボ

1. GitHub Gistとは?

GitHub Gist(ギスト)は、ソースコードや設定ファイル、技術メモなどを手軽に保存・共有できるGitHubのサービスです。

通常のGitHubリポジトリを作成するほどではない、ちょっとしたプログラムやコマンドを残したい場合に便利です。

例えば、次のような用途があります。

  • SwiftやJavaScriptのサンプルコード
  • Gitコマンドの備忘録
  • エラーと解決方法の記録
  • SQLクエリの保存
  • JSONやYAMLの設定例
  • Markdown形式の技術記事
  • AIに渡すプロンプトのテンプレート

GistもGitリポジトリとして管理されているため、編集履歴を残したり、クローンしたりできます。

2. GitHubとGistは何が違う?

比較項目 GitHubリポジトリ GitHub Gist
主な用途 プロジェクト開発 小規模なコードやメモの共有
複数ファイル 対応 対応
Git履歴 あり あり
クローン 可能 可能
プルリクエスト あり 通常のPR機能なし
Issue管理 あり なし
技術メモの公開 可能 特に手軽

本格的な開発はGitHub、再利用できる小さな知識はGistという使い分けが便利です。

3. Gistの作成方法

  1. https://gist.github.com/ にアクセスします。
  2. GitHubアカウントでログインします。
  3. 右上の「+」をクリックします。
  4. Gist descriptionに説明文を入力します。
  5. Filename including extensionにファイル名を入力します。
  6. エディタにコードや文章を書きます。
  7. 公開範囲を選択し、Gistを作成します。

例えば、Gitの便利なコマンドを紹介する場合です。

ファイル名: git-commands.md

# Gitコマンド集

## ブランチ一覧を表示

```bash
git branch

現在の状態を確認

git status

※ 上記はMarkdownの記述例です。実際にはコードブロックの囲みを適切に記述してください。

4. PublicとSecretの違い

Gistには2種類の公開設定があります。

Public Gist

誰でも閲覧でき、Gistの検索やDiscoverにも掲載される公開形式です。

技術記事、サンプルコード、一般公開するドキュメントに向いています。

Secret Gist

一般的な検索結果やDiscoverには表示されにくい形式です。

ただし、Secretは非公開ではありません。URLを知っている人は閲覧できます。

APIキー、パスワード、アクセストークン、個人情報などの秘密情報を保存してはいけません。

また、Publicとして作成したGistを後からSecretに変更することはできません。

5. Markdownで記事を書く

Gistでは、拡張子を .md にするとMarkdownを利用できます。

見出し、表、リスト、リンク、コードブロックなどを組み合わせて、技術記事のように整理できます。

おすすめのファイル構成は次のとおりです。

README.md
sample.js
config.example.json

1つのGistに複数のファイルを保存できるため、解説と実行例をまとめられます。

6. Gistを編集する

作成済みのGistを開き、編集操作から内容を変更できます。

編集履歴は「Revisions」で確認できます。

いつ、どこを変更したのかを差分で追跡できるので、学習記録やコード改善の履歴管理にも利用できます。

7. Gistをクローンする

Gistは通常のGitリポジトリと同じようにクローンできます。

git clone https://gist.github.com/GIST_ID.git

変更後は、通常のGit操作でコミットとプッシュを行えます。

git add .
git commit -m "docs: update gist"
git push

※ 更新には、そのGistへの書き込み権限と適切な認証が必要です。

8. GitHub CLIでGistを作成する

GitHub CLIがインストールされ、認証済みであれば、ターミナルからGistを作成できます。

gh gist create README.md --public

説明文を付ける場合は、次のようにします。

gh gist create README.md \
  --public \
  --desc "GitHub Gistの使い方"

Gist一覧を確認する場合は、次のコマンドです。

gh gist list

GitHub CLIを使用することで、ブラウザを開かずに技術メモを公開できます。

9. ブログや技術記事に埋め込む

Gistのコードは、埋め込みに対応したブログなどで表示できます。

GistページのEmbedから埋め込み用コードを取得します。

<script src="https://gist.github.com/USERNAME/GIST_ID.js"></script>

特定のファイルだけを表示する場合は、?file=ファイル名 を利用できます。

ただし、投稿先のサービスがscriptタグによる埋め込みを許可している必要があります。

10. プログラミングラボでの活用例

スクランブル研究所では、次のように使い分けると便利です。

管理先 保存する内容
GitHub Gist 単独で使えるサンプルコード、コマンド集
TeamSunstripe/GitHub GitHubの開発フローやスキル
TeamSunstripe/Documents 正式仕様書、運用ルール
TeamSunstripe/ReportFiles 実験結果、不具合と対策の記録
Qiita / note 読者向けの解説記事

Gistを技術メモの共有場所として活用し、正式な仕様や開発ルールはリポジトリに残すことで、情報の重複や管理漏れを減らせます。

11. 注意点

Gistを利用する際は、次のことに注意しましょう。

  • Secret Gistを安全な秘密情報保管場所として使用しない
  • 他人のコードを転載する場合はライセンスを確認する
  • 古いAPIや廃止された文法を含むコードには、対象バージョンを記載する
  • 本格的な共同開発には通常のGitHubリポジトリを使用する
  • 公開前に認証情報や個人情報が含まれていないか確認する

まとめ

GitHub Gistは、小さなプログラムや技術知識を手軽に保存・共有できるサービスです。

コードを残すだけではなく、Markdownによる記事作成、Gitによる履歴管理、外部サイトへの埋め込みにも対応しています。

日々の開発で得られた小さな発見をGistに残していけば、自分だけの技術辞典を育てることができます。


参考資料

1
2
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
1
2

Delete article

Deleted articles cannot be recovered.

Draft of this article would be also deleted.

Are you sure you want to delete this article?