Copy Repo Button Customization
About 149 wordsLess than 1 minute
Customize the appearance of the Copy Repo button to make your template repository more appealing.
Use Cases
- Customize the Copy Repo button for template or example repositories
- Enhance user experience with personalized hover images
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.pngParameter 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 file size: 10 MB.