Skip to main content
ドキュメントへの更新が頻繁に発行されており、このページの翻訳はまだ行われている場合があります。 最新の情報については、「英語のドキュメント」を参照してください。
All products
GitHub Codespaces

[GitHub Codespaces で開く] バッジの追加

この記事の内容

リポジトリ内の Markdown ファイルにバッジを追加し、ユーザーがクリックして codespace を作成できるようにすることができます。

概要

Markdown ファイルに [GitHub Codespaces で開く] バッジを追加すると、リポジトリの codespace を簡単に作成できます。

README ページの [GitHub Codespaces で開く] バッジのスクリーンショット。

バッジを作成するときに、そのバッジで作成される codespace に対して特定の構成オプションを選ぶことができます。

ユーザーがバッジをクリックすると、codespace の作成用の [詳細オプション] ページに移動します。選んだオプションは事前に選択されています。 詳細オプション ページについて詳しくは、「リポジトリの codespace を作成する」をご覧ください。

[詳細オプション] ページから、ユーザーは必要に応じて事前に選択された設定を変更し、 [codespace の作成] をクリックできます。

[GitHub Codespaces で開く] バッジの作成

  1. GitHub.com で、リポジトリのメイン ページへ移動します。

  2. リポジトリ名の下で、現在のブランチの名前のラベルが付けられたボタンをクリックし、ドロップダウン メニューで、バッジを作成するブランチを選びます。

    展開されたブランチのドロップダウン メニューのスクリーンショット。さまざまなブランチが一覧表示されています。 ブランチ アイコンと [trunk] のラベルが付いたドロップダウン メニューが、濃いオレンジ色の枠線で強調表示されています。

  3. [ コード] ボタンをクリックし、 [Codespaces] タブをクリックします。

  4. [Codespaces] タブの右上にある [] を選び、 [オプションを指定して新規作成] をクリックします。

    [Codespaces] タブのオプション ドロップダウンのスクリーンショット。[オプションを指定して新規作成] オプションが表示されています。

  5. codespace 作成の [詳細オプション] ページで、各フィールドで事前に選択される値を選びます。

    [ブランチ]、[開発コンテナーの構成]、[リージョン]、[マシンの種類] のドロップダウン メニューが表示された詳細オプション ページのスクリーンショット。

  6. ブラウザーのアドレス バーから URL をコピーします。

  7. たとえば、リポジトリの README.md ファイルに次の Markdown を追加します。

    Markdown
    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](COPIED-URL)

    次に例を示します。

    [![Open in GitHub Codespaces](https://github.com/codespaces/badge.svg)](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=0000000&machine=premiumLinux&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)

    上記の例では、0000000 がリポジトリの参照番号になります。 URL のその他の詳細は、[詳細オプション] ページのフィールドで選んだ値によって決まります。