github仓库使用和提交规范
仓库结构
bash
├── .vitepress # vitepress配置文件夹
│ ├── dist # vitepress打包文件夹（打包完的网站会放在这）
│ ├── theme # 网站主题文件夹*
│ └── config.js # vitepress配置文件*
├── docs # 文档文件夹
├── assets # 静态资源文件夹
├── components # vue组件文件夹*
├── .gitignore # git忽略文件*
├── README.md # 仓库说明文件
├── package.json # 项目配置文件*
├── build.sh # 项目打包脚本*
└── index.md # 知识库首页├── .vitepress # vitepress配置文件夹
│ ├── dist # vitepress打包文件夹（打包完的网站会放在这）
│ ├── theme # 网站主题文件夹*
│ └── config.js # vitepress配置文件*
├── docs # 文档文件夹
├── assets # 静态资源文件夹
├── components # vue组件文件夹*
├── .gitignore # git忽略文件*
├── README.md # 仓库说明文件
├── package.json # 项目配置文件*
├── build.sh # 项目打包脚本*
└── index.md # 知识库首页INFO
请不要随意修改标识有*的文件/文件夹
新建文章
在docs文件夹下新建.md文件，文件名即为文章标题。
md文件格式如下（你可以直接复制到新的md文件中）：
md
---
author:
- 贡献者1
- 贡献者2
---
# （文章标题）
目录（可选）
[[toc]]
（正文内容）---
author:
- 贡献者1
- 贡献者2
---
# （文章标题）
目录（可选）
[[toc]]
（正文内容）文件
文件可以放在docs文件夹下的任意位置，为了方便管理，请放在调用文件的md文件同级目录下。
commit & issue message规范
提交commit和issue时，提交信息应该遵循格式：emoji type: message
emjoi type 为提交类型，message为提交信息
初始化（init）
创建项目时
🎉 init: 创建项目🎉 init: 创建项目新功能（feature）
设计功能代码的更新
✨ feat: 添加了xxx功能✨ feat: 添加了xxx功能修补bug（fix）
修改代码bug
🐛 fix: 修复了xxx bug🐛 fix: 修复了xxx bug添加文档
向仓库中添加文档
📚 add: 添加了xxx文档📚 add: 添加了xxx文档勘误
勘误文档错误
👈 corrig: 修正了xxx文档错误👈 corrig: 修正了xxx文档错误修改文档
修改文档
📖 modify: 修改了xxx文档📖 modify: 修改了xxx文档性能优化
优化代码
🔥 perf: 优化了xxx代码🔥 perf: 优化了xxx代码格式
整理格式，不涉及功能以及意义上的改动
🎨 style: 整理了xxx格式🎨 style: 整理了xxx格式重构
仓库结构改动/功能重构
🔨 refactor: 重构了xxx功能🔨 refactor: 重构了xxx功能回滚
回滚到上一个版本
⏪ revert: 回滚到上一个版本⏪ revert: 回滚到上一个版本测试
🚨 test: 测试🚨 test: 测试构建过程或辅助工具的变动
🔧 chore: 构建过程或辅助工具的变动🔧 chore: 构建过程或辅助工具的变动持续集成的配置文件和脚本的变动
🔩 ci: 持续集成的配置文件和脚本的变动🔩 ci: 持续集成的配置文件和脚本的变动其他
其他
🚩 other: 其他🚩 other: 其他