18a2cc8498
Co-authored-by: github-actions <github-actions@github.com> Co-authored-by: Kevin Heis <heiskr@users.noreply.github.com> Co-authored-by: Isaac Brown <101839405+isaacmbrown@users.noreply.github.com> Co-authored-by: Peter Bengtsson <peterbe@github.com>
3.0 KiB
title, shortTitle, intro, allowTitleToDifferFromFilename, versions, type, topics, redirect_from
| title | shortTitle | intro | allowTitleToDifferFromFilename | versions | type | topics | redirect_from | |||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Adding an "Open in GitHub Codespaces" badge | Add a Codespaces badge | You can add a badge to a Markdown file in your repository which people can click to create a codespace. | true |
|
how_to |
|
|
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 for a repository."
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 %}
-
Under the repository name, use the "Branch" dropdown menu, and select the branch you want to create the badge for.
-
Click the {% octicon "code" aria-label="The code icon" %} Code button, then click the Codespaces tab.
-
Click the ellipsis (...) at the top right of the Codespaces tab, then click New with options.
-
On the advanced options page for codespace creation, select the values you want to be preselected in each field.
-
Copy the URL from the browser's address bar.
-
Add the following Markdown to, for example, the
README.mdfile of your repository:[](COPIED-URL)For example:
[](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,
0000000will 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.
