Use the deploy button to create a Vercel Project from any GitHub repository or GitLab project, including branches and subdirectories, and optionally create a copy of the original repository in your Git account.
The example below shows how the deploy button looks when rendered, clicking it allows you to deploy our Gatsby example.
Consisting of an
.svg asset and an associated link to a public GitHub repository or GitLab project, the deploy button can be used wherever its rendering is supported.
When implementing the deploy button, provide a link with it to the
/import/project endpoint and pass a GitHub repository or GitLab project as the template query parameter like so:
The template parameter can be either a repository URL, or alternatively, a URL for a folder within that repository, both are supported.
By combining both the button and the
/import/project endpoint, you can provide users with a way to deploy projects in seconds. Some common use cases are listed below.
To render the deploy button in a Markdown file, for example a Git
README.md, use the following code, changing only the template parameter:
[![Deploy to Vercel](/button)](/import/project?template=https://github.com/zeit/now/tree/master/examples/gatsby)
To use the Deploy to Vercel button with HTML, add the button as an image and wrap it with a link to the endpoint, changing only the template parameter:
<a href="/import/project?template=https://github.com/zeit/now/tree/master/examples/gatsby" > <img src="https://vercel.com/button" alt="Deploy" /> </a>