抄作业按钮定制

376 字约 1 分钟

定制抄作业按钮的外观，让你的模板仓库更具吸引力。

使用场景

为模板仓库或示例仓库定制抄作业按钮，引导用户快速复制仓库，通过个性化悬浮图片提升用户体验。

前置条件

仓库首页默认不会显示「抄作业」按钮。需先在仓库首页右侧简介编辑中添加 example 标签，适合模板仓库或示例仓库启用此功能。

点击该按钮后，用户可快速了解如何复制该仓库。

配置方式

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

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

参数说明

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