上手指南
代码分支命名规范
代码拉取到本地仓库以后,切换分支,命名为feature/*
,比如你开发了一个sum
函数,那就以feature/sum
命名。
commit信息严格按照下面的规范执行
前缀 | 解释 |
---|---|
feat | 新功能 |
fix | 修复 |
docs | 文档变更 |
style | 代码格式 |
refactor | 重构 |
perf | 性能优化 |
test | 增加测试 |
revert | 回退 |
build | 打包 |
chore | 构建过程或辅助工具的变动 |
安装依赖
如何添加一个工具函数
创建文件
在src/
下面创建一个工具函数文件,文件名需要语义化,比如copyText.js
添加内容:
/*
* @Author: 朽木白
* @Date: 2022-09-30 16:17:47
* @LastEditors: 1547702880@@qq.com
* @LastEditTime: 2022-09-30 17:34:30
* @Description: 文本复制
*/
export const copyText = (text) => navigator.clipboard.writeText(text)
注意添加头文件注释
添加依赖
在src/index.js
当中暴露接口
export { copyText } from './copyText'
添加文档
在docs/utils/
下添加md
文件copyText.md
添加向光文档说明:
# 文字复制到剪贴板
Clipboard API 它的所有操作都是异步的,返回 Promise 对象,不会造成页面卡顿。而且,它可以将任意内容(比如图片)放入剪贴板。
```js
const copyText = async (text) => await navigator.clipboard.writeText(text)
copyText('单行代码 前端世界')
添加sidebar,在`src/.vitepress/config.js`中,找到`sidebar配置项`,添加
```shell
{ text: "copyText", link: '/utils/copyText' },
预览效果:
yarn docs:dev