Skip to content

Add an Open in Gitpod button to your README

I like to add Gitpod buttons to the README files of GitHub repos that are good for using with Gitpod (ie not developing desktop GUI software), so I, or any potential other contributors, can get an environment up and running quickly.

I always have to look up the correct syntax for the Markdown embed, pretty button graphic and Gitpod URL, so here’s the snippet.

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#<your-repository-url>)

Here’s an example, to open the code for this repo in Gitpod:

[![Open in Gitpod](https://gitpod.io/button/open-in-gitpod.svg)](https://gitpod.io/#https://github.com/caro401/public-notes)

and the resulting button

Open in Gitpod

Sources