docs：更新文档

docs/.vitepress/config.js

@@ -0,0 +1,47 @@
+const config = {
+  title: '简约而不简单的文档',
+  themeConfig: {
+    repo: 'https://github.com/xiaoxian521',
+    docsDir: 'docs',
+    locales: {
+      '/': {
+        lang: 'zh-CN',
+        nav: [
+          { text: '书写规范', link: '/zh/standard/' },
+          { text: '插件分享', link: '/zh/plugs/' },
+        ],
+        sidebar: [
+          {
+            text: '简介',
+            children: [
+              { text: '项目描述', link: '/zh/introduction/description' },
+              { text: '开源精神', link: '/zh/introduction/openSource' },
+              { text: '贡献者', link: '/zh/introduction/contributor' },
+              { text: '设计图及UI规范', link: '/zh/introduction/ui' },
+            ],
+          },
+        ],
+      },
+      '/en/': {
+        lang: 'en-US',
+        nav: [
+          { text: 'Standard', link: '/en/standard/' },
+          { text: 'PlugsShare', link: '/zh/plugs/' },
+        ],
+        sidebar: [
+          {
+            text: 'introduction',
+            children: [
+              { text: 'description', link: '/en/introduction/description' },
+              { text: 'openSource', link: '/en/introduction/openSource' },
+              { text: 'contributor', link: '/en/introduction/contributor' },
+              { text: 'DesignDrawing、UISpecification', link: '/en/introduction/ui' },
+            ],
+          },
+        ],
+      },
+    }
+  }
+}
+
+module.exports = config

docs/en/index.md

@@ -0,0 +1,8 @@
+:tada: :100:
+::: tip
+Welcome to join the open source family. Let's look at the document on the left and explore it! :heart_eyes_cat:
+:::
+
+::: warning
+This document is written by vitepress. As vitepress is being improved, it is normal to encounter small bugs in browsing :joy:
+:::

docs/en/introduction/contributor.md

@@ -0,0 +1,33 @@
+# contributor
+
+:tada: :100:
+::: tip
+```
+和尚 
+```
+GitHub：https://github.com/xiaoxian521
+:::
+
+:tada: :100:
+::: tip
+```
+chenxi 
+```
+GitHub：https://github.com/chenxi19950223/wxnode
+:::
+
+:tada: :100:
+::: tip
+```
+ChaoSuperScholar 
+```
+GitHub：https://github.com/ChaoSuperScholar/smallhouse
+:::
+
+:tada: :100:
+::: tip
+```
+Yinwenxu 
+```
+GitHub：https://github.com/Yinwenxu/Student
+:::

docs/en/introduction/description.md

@@ -0,0 +1,8 @@
+# description
+
+### A system of adding, deleting, modifying and checking based on TS
+
+## Main Technologies:
+| front end | after end | database | 
+| -- |:--:| -- |
+| Vue3.0、React、Angular | Node | MySQL、MongoDB、SQlite | 

docs/en/introduction/openSource.md

@@ -0,0 +1,26 @@
+# openSource
+
+## Why contribute to open source?
+
+### Improve software you rely on
+Lots of open source contributors start by being users of software they contribute to. When you find a bug in an open source software you use, you may want to look at the source to see if you can patch it yourself. If that’s the case, then contributing the patch back is the best way to ensure that your friends (and yourself when you update to the next release) will be able to benefit from it.
+
+### Improve existing skills
+Whether it’s coding, user interface design, graphic design, writing, or organizing, if you’re looking for practice, there’s a task for you on an open source project.
+
+### Meet people who are interested in similar things
+Open source projects with warm, welcoming communities keep people coming back for years. Many people form lifelong friendships through their participation in open source, whether it’s running into each other at conferences or late night online chats about burritos.
+
+### Find mentors and teach others
+Working with others on a shared project means you’ll have to explain how you do things, as well as ask other people for help. The acts of learning and teaching can be a fulfilling activity for everyone involved.
+
+### Build public artifacts that help you grow a reputation (and a career)
+By definition, all of your open source work is public, which means you get free examples to take anywhere as a demonstration of what you can do.
+
+### Learn people skills
+Open source offers opportunities to practice leadership and management skills, such as resolving conflicts, organizing teams of people, and prioritizing work.
+
+### It’s empowering to be able to make changes, even small ones
+You don’t have to become a lifelong contributor to enjoy participating in open source. Have you ever seen a typo on a website, and wished someone would fix it? On an open source project, you can do just that. Open source helps people feel agency over their lives and how they experience the world, and that in itself is gratifying.
+
+### You can learn about the open source spirit here: http://opensource.guide/

docs/en/introduction/ui.md

@@ -0,0 +1,15 @@
+## UI specification
+#### 1. A good "product" reflects your cultural and aesthetic details, ha ha, try to unify the page effect! :grin:
+#### 2. Using the unified icon, I will pull you into the corresponding iconfont project :kissing_heart:
+
+## Design drawings
+
+![Screen shot](./images/bg.png)
+#### Background image (right click to save as picture)
+![Screen shot](./images/login.png)
+#### Login page
+![Screen shot](./images/register.png)
+#### Register page
+
+## Project reference address (UI appearance)
+http://beautiful.panm.cn/vue-admin-beautiful-pro/?hmsr=github&hmpl=&hmcu=&hmkw=&hmci=#/login?redirect=%2Findex

docs/en/plugs/index.md

@@ -0,0 +1,37 @@
+## 1. VsCode Plugs
+
+please install TSLint、Vetur、vscode-icons、ES7 React
+
+## 2. Quick generation of code fragment by vscode
+Ctrl+Shift+P Check configure user code fragment search vue.json Copy the code below Enter Vue in the .vue file and press enter
+```
+{
+	"Vue3.0Quick template generation": {
+		"prefix": "Vue3.0",
+		"body": [
+			"<template>",
+			"\t<div>\n",
+			"\t</div>",
+			"</template>\n",
+			"<script lang='ts'>",
+			"export default {",
+			"\tsetup(){",
+			"\t\treturn{\n\n\t\t}",
+			"\t},",
+			"}",
+			"</script>\n",
+			"<style scoped>\n",
+			"</style>",
+			"$2"
+		],
+		"description": "Vue3.0"
+	}
+}
+```
+![Screen shot](./images/snip.gif)
+## 3. hyper
+
+![Screen shot](./images/hyper.gif)
+
+A beautification command panel plug-in, based on TS, version: windows, MAC, Linux  
+Download address: https://hyper.is/#installation

docs/en/standard/index.md

@@ -0,0 +1,16 @@
+# Writing Standard
+
+:tada: :100:
+::: tip
+① Interface documents use swagger
+② The author must strictly abide by the tslint writing rules in the project
+③ The author must strictly follow the code naming semantics and improve the readability of the code
+④ The author must go through the unit test to ensure the usability of the code
+⑤ Typescript must be used completely to ensure code rigor and maintainability
+⑥ If the code submitted by the writer conflicts, it must be resolved first. In pushing, GIT push - f origin branch is strictly prohibited
+⑦ Put Vue code under Vue TS branch, react code under react TS branch and angular code under angular TS branch
+:::
+
+::: danger
+Managers are not allowed to push or merge the code directly into the main branch. The main branch is only used to store the back-end code and document code. In this way, it avoids the need to wait for a long time to pull the code for the first time. After the code is written as a whole, it will be merged into the main branch
+:::

docs/index.md

@@ -0,0 +1,12 @@
+:tada: :100:
+::: tip
+欢迎加入开源大家庭，下面让我们来查看左侧文档进行相关探索吧！:heart_eyes_cat:
+:::
+
+::: warning
+本文档采用vitepress编写，因vitepress正在完善中，浏览中如遇小bug是正常现象。 :joy:
+:::
+
+::: danger
+开发者可能都是比较忙的，感谢付出你的时间来开发此项目，进程会慢，但一定会做完，加油！ :thumbsup:
+:::

docs/zh/introduction/contributor.md

@@ -0,0 +1,32 @@
+# 贡献者
+
+:tada: :100:
+::: tip
+```
+和尚 
+```
+GitHub：https://github.com/xiaoxian521
+:::
+
+:tada: :100:
+::: tip
+```
+chenxi 
+```
+GitHub：https://github.com/chenxi19950223/wxnode
+:::
+
+:tada: :100:
+::: tip
+```
+ChaoSuperScholar 
+```
+GitHub：https://github.com/ChaoSuperScholar/smallhouse
+:::
+
+:tada: :100:
+::: tip
+```
+Yinwenxu 
+```
+:::

docs/zh/introduction/description.md

@@ -0,0 +1,8 @@
+# 项目描述
+
+### 一套整体基于TS的增删改查系统
+
+## 主要技术：
+| 前端 | 后端 | 数据库 | 
+| -- |:--:| -- |
+| Vue3.0、React、Angular | Node | MySQL、MongoDB、SQlite | 

docs/zh/introduction/openSource.md

@@ -0,0 +1,23 @@
+# 开源精神
+
+## 为什么要为开源做贡献？
+
+### 巩固现有技能
+无论是撰写代码、设计用户界面、图形设计、撰写文档、亦或是组织活动，假如你有实践的愿望，你总能在开源项目中找到自己的位置。
+
+### 遇见那些和你”臭味相投”的人
+开源项目一般都会有一个和谐、热心的社区，以让大家团结一致。实际上，开源界经常发生这样的情形，很多人的深厚友谊都是通过共同参与开源所建立起来的，至于具体的方式，可能是在一次技术研讨会上相谈甚欢，也可能是一直在聊天室中探讨问题。
+
+### 寻找导师，并且尝试帮助他人
+和他人共同在一个共享的项目下工作，这意味着需要向他人解释清楚自己是如何做的，同理，也需要向他人求助，询问别人是如何做的。相互学习和彼此教学对于每位参与者都能满载而归。
+
+### 在公众间建立你的声誉（职业口碑）
+根据开源的定义，你在开源下所有的工作都是公开的，这也就意味着开源项目是一个很好展示你实力的地方。
+
+### 学习领导和管理的艺术
+开源为实践领导力和管理技能提供了很好的机会，比如解决冲突、组织团队、工作的优先级排列。
+
+### 鼓励作出改变，哪怕改变是很微小的
+在开源的世界里，作出贡献的不一定非得是花了很长时间拥有大量经验的人。你是否遇到过浏览某些网站发现有拼写错误，希望有人能修改它？其实，在开源的项目中，你只需要做就可以了。没有那么多的顾忌，开源让人们在很舒服的状态做事，而这才是这个世界应有的体验。
+
+### 关于开源精神你可以来这里学习：http://opensource.guide/zh-hans/

docs/zh/introduction/ui.md

@@ -0,0 +1,15 @@
+## UI规范
+#### 1. 一款好的“产品”体现了您的文化、审美底蕴，哈哈，尽量页面效果统一！ :grin:
+#### 2. 使用统一的icon，我会拉你们进对应的iconfont项目！ :kissing_heart:
+
+## 设计图
+
+![Screen shot](./images/bg.png)
+#### 背景图（可右键另存为图片）
+![Screen shot](./images/login.png)
+#### 登录页
+![Screen shot](./images/register.png)
+#### 注册页
+
+## 项目参考地址（UI外观）
+http://beautiful.panm.cn/vue-admin-beautiful-pro/?hmsr=github&hmpl=&hmcu=&hmkw=&hmci=#/login?redirect=%2Findex

docs/zh/plugs/index.md

@@ -0,0 +1,38 @@
+## 1. VsCode插件
+
+请安装TSLint、Vetur、vscode-icons、ES7 React
+
+## 2. VsCode快速生成代码片段
+Ctrl+Shift+P 选中配置用户代码片段 搜索vue.json，将下面代码复制进去，在.vue文件输入vue回车即可
+```
+{
+	"Vue3.0快速生成模板": {
+		"prefix": "Vue3.0",
+		"body": [
+			"<template>",
+			"\t<div>\n",
+			"\t</div>",
+			"</template>\n",
+			"<script lang='ts'>",
+			"export default {",
+			"\tsetup(){",
+			"\t\treturn{\n\n\t\t}",
+			"\t},",
+			"}",
+			"</script>\n",
+			"<style scoped>\n",
+			"</style>",
+			"$2"
+		],
+		"description": "Vue3.0"
+	}
+}
+```
+![Screen shot](./images/snip.gif)
+
+## 3. hyper
+
+![Screen shot](./images/hyper.gif)
+
+一款美化命令面板插件，基于TS，版本：windows、mac、linux  
+下载地址：https://hyper.is/#installation

docs/zh/standard/index.md

@@ -0,0 +1,16 @@
+# 书写规范
+
+:tada: :100:
+::: tip
+① 接口文档使用Swagger  
+② 编写者必须严格遵守项目中tslint编写规则  
+③ 编写者必须严格遵循代码命名语义化、提高代码可读性  
+④ 编写者编写代码完毕必须经过单元测试，保证代码可用性  
+⑤ 编写必须完全使用TypeScript，保证代码严谨性、可维护性  
+⑥ 编写者提交代码发生冲突，必须先解决，在推送，严禁使用git push -f origin 分支  
+⑦ vue代码请放在vue-ts分支下，react代码请放在react-ts分支下，angular代码请放在angular-ts分支下
+:::
+
+::: danger
+管理者严禁将代码直接推送或合并到main分支，main分支只用来存放后端代码和文档代码，这样避免了首次拉取代码需要等很长时间，代码整体编写完毕后会合并到main分支
+:::