b759380936
Co-authored-by: Craig Peters <craiglpeters@github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com>
60 lines
2.9 KiB
Markdown
60 lines
2.9 KiB
Markdown
---
|
|
title: Adding an "Open in GitHub Codespaces" badge
|
|
shortTitle: Add a Codespaces badge
|
|
intro: 'You can add a badge to a Markdown file in your repository which people can click to create a codespace.'
|
|
allowTitleToDifferFromFilename: true
|
|
versions:
|
|
fpt: '*'
|
|
ghec: '*'
|
|
type: how_to
|
|
topics:
|
|
- Codespaces
|
|
- Set up
|
|
---
|
|
|
|
## Overview
|
|
|
|
Adding an "Open in {% data variables.product.prodname_github_codespaces %}" badge to a Markdown file gives people an easy way to create a codespace for your repository.
|
|
|
|
|
|
|
|
When you create a badge you can choose specific configuration options for the codespace that the badge will create.
|
|
|
|
When people click the badge they'll be taken to the advanced options page for codespace creation, with the options you chose preselected. For more information about the advanced options page, see "[Creating a codespace](/codespaces/developing-in-codespaces/creating-a-codespace#creating-a-codespace)."
|
|
|
|
From the advanced options page, users can change the preselected settings if required, then click **Create codespace**.
|
|
|
|
## Creating an "Open in {% data variables.product.prodname_github_codespaces %}" badge
|
|
|
|
{% data reusables.repositories.navigate-to-repo %}
|
|
1. Under the repository name, use the "Branch" dropdown menu, and select the branch you want to create the badge for.
|
|
|
|
|
|
|
|
1. Click the **{% octicon "code" aria-label="The code icon" %} Code** button, then click the **Codespaces** tab.
|
|
|
|
|
|
|
|
1. Click the down arrow at the side of the **Create codespace on BRANCH** button, click **Configure and create codespace**, then click the **Configure and create codespace** button.
|
|
|
|
|
|
|
|
1. On the advanced options page for codespace creation, select the values you want to be preselected in each field.
|
|
|
|
|
|
|
|
1. Copy the URL from the browser's address bar.
|
|
1. Add the following Markdown to, for example, the `README.md` file of your repository:
|
|
|
|
```Markdown{:copy}
|
|
[](COPIED-URL)
|
|
```
|
|
|
|
For example:
|
|
|
|
```Markdown
|
|
[](https://github.com/codespaces/new?hide_repo_select=true&ref=main&repo=0000000&machine=premiumLinux&devcontainer_path=.devcontainer%2Fdevcontainer.json&location=WestUs2)
|
|
```
|
|
|
|
In the above example, `0000000` will be the reference number of your repository. The other details in the URL are determined by the values you selected in the fields on the advanced options page.
|