docs:更新文档

This commit is contained in:
张益铭
2021-03-01 15:06:11 +08:00
parent 1542135ab0
commit 9064b372e8
5835 changed files with 904126 additions and 161722 deletions

8
docs/en/index.md Normal file
View File

@@ -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:
:::

View File

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

View File

@@ -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 |

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.1 MiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 541 KiB

View File

@@ -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 thats 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 its coding, user interface design, graphic design, writing, or organizing, if youre looking for practice, theres 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 its 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 youll 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.
### Its empowering to be able to make changes, even small ones
You dont 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/

View File

@@ -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

Binary file not shown.

After

Width:  |  Height:  |  Size: 243 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 252 KiB

37
docs/en/plugs/index.md Normal file
View File

@@ -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

16
docs/en/standard/index.md Normal file
View File

@@ -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
:::