Copy Repo Button Customization

About 174 wordsLess than 1 minute

Copy Repo Button Customization explains how to change the text and hover image of the Copy Repo button on a template repository's home page.

When to use: when you want a template or example repository to stand out, for example to add a one-line prompt that invites users to copy it, or a hover image that draws clicks.

Prerequisites

The Copy Repo button is not displayed by default. Add the example tag in the repository description first.

Configuration

Add the copyRepo configuration to .cnb/settings.yml in the repository's default branch:

.cnb/settings.yml
copyRepo:
  button:
    description: Your repo is great, now it's mine
    hoverImage: .cnb/copy-hover.png

Parameter Reference

Parameter	Type	Default	Description
`copyRepo.button.description`	string	-	Description text of the Copy Repo button
`copyRepo.button.hoverImage`	string	-	Image on hover (see below for details)

hoverImage details: Supports repository relative paths or raw URLs. Maximum size: 10 MB.