抄作业按钮定制

389 字约 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