Skip to content

Commit

Permalink
docs: add deploy button changelog
Browse files Browse the repository at this point in the history
  • Loading branch information
atinux committed Jul 22, 2024
1 parent ca132e7 commit e9ecf1f
Show file tree
Hide file tree
Showing 2 changed files with 46 additions and 0 deletions.
46 changes: 46 additions & 0 deletions docs/content/4.changelog/deploy-button.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
title: Deploy to NuxtHub button
description: "The Deploy to NuxtHub button allows you to deploy a GitHub template directly from the NuxtHub Admin."
date: 2024-07-22
image: '/images/changelog/deploy-button.png'
category: Template
authors:
- name: Sebastien Chopin
avatar:
src: https://avatars.githubusercontent.com/u/904724?v=4
to: https://x.com/atinux
username: atinux
- name: Ahad Birang
avatar:
src: https://avatars.githubusercontent.com/u/2047945?v=4
to: https://x.com/a_birang
username: a_birang
---

We are glad to introduce the "Deploy to NuxtHub" to deploy any Nuxt template made by the community with a single click.

It is designed to be used in the README of a GitHub repository, documentations or any other place where you want to allow users to deploy your project with one click.

:nuxt-img{src="/images/changelog/deploy-button.png" alt="NuxtHub Deploy Button" width="915" height="515"}

## Deploy Button

1. The image of the button is on `https://hub.nuxt.com/button.svg`
2. The link to deploy the project is `https://hub.nuxt.com/new?repo=ORG/REPO` (replace `ORG/REPO` with your GitHub repository)
3. Your repository must be public and marked as "Template repository" on GitHub

To use the button, you need to add the following markdown to your README:

::code-group

```md [Markdown]
[![Deploy to NuxtHub](https://hub.nuxt.com/button.svg)](https://hub.nuxt.com/new?repo=ORG/REPO)
```

```html [HTML]
<a href="https://hub.nuxt.com/new?repo=ORG/REPO"><img src="https://hub.nuxt.com/button.svg" alt="Deploy to NuxtHub"></a>
```

::

You can see an example of the button in action in the [Instadraw repository](https://github.com/atinux/instadraw).
Binary file added docs/public/images/changelog/deploy-button.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit e9ecf1f

Please sign in to comment.