Issue Button Customization

About 188 wordsLess than 1 minute

Customize the appearance of the Create Issue button to give your repository more personality.

Use Cases

Add a fun description to your repository's Issue button
Provide better visual guidance through hover images
Create a unique community contribution atmosphere

Configuration

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

.cnb/settings.yml
# Issue configuration, reads the .cnb/settings.yml configuration from the repository's default branch
issue:
  # Customize the create issue button
  button:
    # Button description
    description: ~bug~ Here you go!
    # Image displayed when hovering over the button
    # 1.Use images from the repository's default branch, specify the path relative to the repository root directory, e.g., .cnb/issue-hover.png;
    # 2.Use the raw file address under the current domain name, for example: https://cnb.cool/my/test/-/git/raw/main/issue-hover.png
    # Image maximum 10MB
    hoverImage: https://cnb.cool/my/test/-/git/raw/main/issue-hover.png

Parameter Reference

Parameter	Type	Default	Description
`issue.button.description`	string	-	The description text of the Issue button
`issue.button.hoverImage`	string	-	Image displayed on hover. Supports repository relative path or raw URL, max 10MB