---
url: /zh/repo/settings-fork.md
description: 介绍如何通过 .cnb/settings.yml 定制仓库 Fork 按钮的描述文字和鼠标悬浮图片，为开源项目营造个性化的 Fork 体验。
---
定制 Fork 按钮的外观，让 fork 操作更有趣。

## 使用场景

* 为 Fork 按钮添加个性化的描述
* 通过悬浮图片吸引用户 fork 你的项目
* 在开源项目中营造友好、有趣的贡献氛围

## 配置方式

在 `.cnb/settings.yml` 中添加 `fork` 配置：

```yaml title=".cnb/settings.yml"
# fork 配置，读取仓库默认分支 .cnb/settings.yml 配置
fork:
  # 定制 fork 按钮
  button:
    # 按钮描述
    description: 你的仓库不错，现在是我的了
    # 鼠标悬浮在按钮上显示的图片
    # 1.用仓库中默认分支的图片，填写相对仓库根目录的路径，如 .cnb/fork-hover.png;
    # 2.使用当前域名下的文件 raw 地址，比如：https://cnb.cool/my/test/-/git/raw/main/.cnb/fork-hover.png
    # 图片最大 10MB
    hoverImage: .cnb/fork-hover.png
```

## 参数说明

| 参数 | 类型 | 默认值 | 说明 |
|------|------|--------|------|
| `fork.button.description` | string | - | Fork 按钮的描述文字 |
| `fork.button.hoverImage` | string | - | 鼠标悬浮时显示的图片，支持仓库相对路径或 raw 地址，最大 10MB |