Fork Button Customization

About 142 wordsLess than 1 minute

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

When to use: when you want the Fork entry point to be more playful and clickable, for example to use a witty line as the description, or a hover image that builds a friendly contribution atmosphere in your open-source community.

Configuration

Add the fork configuration to .cnb/settings.yml:

.cnb/settings.yml
fork:
  button:
    description: Nice repo you've got. Now it's mine.
    hoverImage: .cnb/fork-hover.png

Parameter Reference

fork.button.description (string)
The description text of the Fork button.
fork.button.hoverImage (string)
Image displayed on hover. Supports repository relative path or raw URL, max 10MB.