上手指南

点击查看【bilibili】

代码分支命名规范

代码拉取到本地仓库以后,切换分支,命名为feature/*,比如你开发了一个sum函数,那就以feature/sum命名。
commit信息严格按照下面的规范执行

前缀 解释
feat 新功能
fix 修复
docs 文档变更
style 代码格式
refactor 重构
perf 性能优化
test 增加测试
revert 回退
build 打包
chore 构建过程或辅助工具的变动

安装依赖

使用yarn管理工具

如何添加一个工具函数

示例:复制文字

创建文件

src/下面创建一个工具函数文件,文件名需要语义化,比如copyText.js
添加内容:

  1. /*
  2. * @Author: 朽木白
  3. * @Date: 2022-09-30 16:17:47
  4. * @LastEditors: 1547702880@@qq.com
  5. * @LastEditTime: 2022-09-30 17:34:30
  6. * @Description: 文本复制
  7. */
  8. export const copyText = (text) => navigator.clipboard.writeText(text)

注意添加头文件注释

添加依赖

src/index.js当中暴露接口

  1. export { copyText } from './copyText'

添加文档

docs/utils/下添加md文件copyText.md
添加向光文档说明:

  1. # 文字复制到剪贴板
  2. Clipboard API 它的所有操作都是异步的,返回 Promise 对象,不会造成页面卡顿。而且,它可以将任意内容(比如图片)放入剪贴板。
  3. ```js
  4. const copyText = async (text) => await navigator.clipboard.writeText(text)
  5. copyText('单行代码 前端世界')
  1. 添加sidebar,在`src/.vitepress/config.js`中,找到`sidebar配置项`,添加
  2. ```shell
  3. { text: "copyText", link: '/utils/copyText' },

预览效果:

  1. yarn docs:dev