Skip to content

docs(idp): add copyable Deploy with Pulumi button snippet #20086

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
CamSoper merged 2 commits into from
Jul 7, 2026
+12 −2
Merged

docs(idp): add copyable Deploy with Pulumi button snippet #20086

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
54a512d
docs(idp): add copyable Deploy with Pulumi button snippet
workprentice Jul 5, 2026
3bae273
docs(idp): drop redundant directional reference
workprentice Jul 5, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 12 additions & 2 deletions content/docs/idp/integrations/pulumi-button.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ For example, select the `Deploy` button to configure and create a new empty Java

[![Deploy](/images/deploy-with-pulumi/dark.svg)](https://app.pulumi.com/new?template=https://github.com/pulumi/templates/javascript)

Rather than right-clicking the button to recover its image URL, copy the Markdown snippet below and drop it straight into a README, gist, or blog post:

```markdown
[![Deploy](https://www.pulumi.com/images/deploy-with-pulumi/dark.svg)](https://app.pulumi.com/new?template=https://github.com/pulumi/templates/javascript)
```

Swap the `template` query parameter for the URL of your own project template to point the button at your repository instead. See [Creating a Pulumi Button](#creating-a-pulumi-button) below for the full Markdown and HTML forms, plus the complete set of button image variants.

To create a _Deploy with Pulumi_ button:

1. Include optional template metadata in your `Pulumi.yaml`.
Expand Down Expand Up @@ -66,17 +74,19 @@ After you've verified your project template works as expected, you can add a but
Here's an example in Markdown:

```markdown
[![Deploy](/images/deploy-with-pulumi/dark.svg)](https://app.pulumi.com/new?template=https://github.com/pulumi/examples/aws-js-s3-folder)
[![Deploy](https://www.pulumi.com/images/deploy-with-pulumi/dark.svg)](https://app.pulumi.com/new?template=https://github.com/pulumi/examples/aws-js-s3-folder)
```

Or, the equivalent HTML:

```html
<a href="https://app.pulumi.com/new?template=https://github.com/pulumi/examples/aws-js-s3-folder">
<img src="/images/deploy-with-pulumi/dark.svg" alt="Deploy">
<img src="https://www.pulumi.com/images/deploy-with-pulumi/dark.svg" alt="Deploy">
</a>
```

Use the fully qualified image URL rather than a relative path — a relative path only resolves on pulumi.com and renders as a broken image once the snippet is pasted into a README hosted elsewhere.

### Button Image

Pulumi provides both SVG and PNG versions of the button image at the following URLs in both light and dark themes:
Expand Down
Loading