project init

doc/README.md

@@ -0,0 +1,19 @@
+# simplicity
+
+简约而不简单的文档
+
+# 安装依赖
+```
+npm install
+```
+
+# 文档启动
+```
+npm run docs
+```
+
+# 文档打包
+```
+npm run docs:build
+```
+打包后会在.vitepress文件夹下生成dist目录

doc/deploy.sh

@@ -0,0 +1,25 @@
+#!/usr/bin/env sh
+
+# 确保脚本抛出遇到的错误
+set -e
+
+# 生成静态文件
+npm run docs:build
+
+# 进入生成的文件夹
+cd docs/.vitepress/dist
+
+# 如果是发布到自定义域名
+# echo 'www.example.com' > CNAME
+
+git init
+git add -A
+git commit -m 'deploy'
+
+# 如果发布到 https://<USERNAME>.github.io
+git push -f git@github.com:xiaoxian521/xiaoxian521.github.io.git master:main
+
+# 如果发布到 https://<USERNAME>.github.io/<REPO>
+# git push -f git@github.com:<USERNAME>/<REPO>.git master:gh-pages
+
+cd -

doc/docs/.vitepress/config.js

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

doc/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:
+:::

doc/docs/en/introduction/contributor.md

@@ -0,0 +1,9 @@
+# contributor
+
+:tada: :100:
+::: tip
+```
+和尚 WeChat：18237613535 
+```
+GitHub：https://github.com/xiaoxian521
+:::

doc/docs/en/introduction/description.md

@@ -0,0 +1,6 @@
+# description
+
+## Main Technologies:
+| front end | after end | database | 
+| -- |:--:| -- |
+| Vue3.0、React、Angular | Node | MySQL、MongoDB、SQlite | 

doc/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/

doc/docs/en/standard/index.md

@@ -0,0 +1,3 @@
+# Writing Standard
+
+

doc/docs/index.md

@@ -0,0 +1,8 @@
+:tada: :100:
+::: tip
+欢迎加入开源大家庭，下面让我们来查看左侧文档进行相关探索吧！:heart_eyes_cat:
+:::
+
+::: warning
+本文档采用vitepress编写，因vitepress正在完善中，浏览中如遇小bug是正常现象。 :joy:
+:::

doc/docs/zh/introduction/contributor.md

@@ -0,0 +1,9 @@
+# 贡献者
+
+:tada: :100:
+::: tip
+```
+和尚 微信：18237613535 
+```
+GitHub：https://github.com/xiaoxian521
+:::

doc/docs/zh/introduction/description.md

@@ -0,0 +1,6 @@
+# 项目描述
+
+## 主要技术：
+| 前端 | 后端 | 数据库 | 
+| -- |:--:| -- |
+| Vue3.0、React、Angular | Node | MySQL、MongoDB、SQlite | 

doc/docs/zh/introduction/openSource.md

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

doc/docs/zh/standard/index.md

@@ -0,0 +1,3 @@
+# 书写规范
+
+

doc/package.json

@@ -0,0 +1,14 @@
+{
+  "name": "simplicity",
+  "version": "0.0.1",
+  "description": "简约而不简单的文档",
+  "author": "和尚",
+  "license": "ISC",
+  "scripts": {
+    "docs": "vitepress dev docs",
+    "docs:build": "vitepress build docs"
+  },
+  "devDependencies": {
+    "vitepress": "^0.7.4"
+  }
+}