feat: 新增一些文档，调整导航栏内容

142vip · Nov 3, 2023 · b556388 · b556388
1 parent 324a422
commit b556388
Show file tree

Hide file tree

Showing 90 changed files with 529 additions and 338 deletions.
diff --git a/docs/.vuepress/config/navbar.ts b/docs/.vuepress/config/navbar.ts
@@ -1,11 +1,14 @@
+import {soloAlgorithmSidebar} from "../../manuscripts/solo-algorithm/solo-algorithm.sidebar";
+
 export default [
   {
     text: "首页",
     link: "/",
   },
   {
     text: "SOLO算法",
-    link: "/manuscripts/solo-algorithm",
+    // link: "/manuscripts/solo-algorithm",
+    children: soloAlgorithmSidebar
   },
   {
     text: "Battle面试官",

diff --git a/docs/.vuepress/config/sidebar.ts b/docs/.vuepress/config/sidebar.ts
@@ -1,19 +1,31 @@
-import {frontEndSidebar} from "../../manuscripts/front-end/front-end.sidebar";
-import {serverEndSidebar} from "../../manuscripts/server-end/server-end.sidebar";
+import {FrontEndSidebar} from "../../manuscripts/front-end/front-end.sidebar";
+import {ServerEndSidebar} from "../../manuscripts/server-end/server-end.sidebar";
 import {eggSidebar} from "../../manuscripts/server-end/framework/egg/egg.sidebar";
 import {developSkillSidebar} from "../../manuscripts/develop-skill/develop-skill.sidebar";
 import {soloAlgorithmSidebar} from "../../manuscripts/solo-algorithm/solo-algorithm.sidebar";
 import {jobChanceSidebar} from "../../manuscripts/job-chance/job-chance.sidebar";
 import {readBooksSidebar} from "../../manuscripts/read-books/read-books.sidebar";
 import {microserviceSidebar} from "../../manuscripts/microservice/microservice.sidebar";
 import {battleInterviewSidebar} from "../../manuscripts/battle-interview/battle-interview.sidebar";
+import {redisSidebar} from "../../manuscripts/server-end/database/redis/redis.sidebar";
+import {mySqlSideBar} from "../../manuscripts/server-end/database/mysql/mysql.sidebar";
+import {mongoSideBar} from "../../manuscripts/server-end/database/mongo/mongo.sidebar";
+import {linuxSidebar} from "../../manuscripts/server-end/linux/linuxSidebar";
+import {nodeLearnSidebar} from "../../manuscripts/server-end/node-learn/nodeLearn.sidebar";
+import {BaseSidebar} from "../../manuscripts/server-end/base/base.sidebar";
 
 export default {
-    "/manuscripts/front-end": frontEndSidebar,
-    "/manuscripts/server-end": serverEndSidebar,
+    "/manuscripts/front-end": FrontEndSidebar,
+    "/manuscripts/server-end": ServerEndSidebar,
     "/manuscripts/server-end/framework/egg": eggSidebar,
+    "/manuscripts/server-end/database/redis": redisSidebar,
+    "/manuscripts/server-end/database/mysql": mySqlSideBar,
+    "/manuscripts/server-end/database/mongo": mongoSideBar,
+    "/manuscripts/server-end/linux": linuxSidebar,
+    "/manuscripts/server-end/base": BaseSidebar,
+    "/manuscripts/server-end/node-learn": nodeLearnSidebar,
     "/manuscripts/develop-skill": developSkillSidebar,
-    "/manuscripts/solo-algorithm": soloAlgorithmSidebar,
+    // "/manuscripts/solo-algorithm": soloAlgorithmSidebar,
     "/manuscripts/read-books": readBooksSidebar,
     "/manuscripts/job-chance": jobChanceSidebar,
     "/manuscripts/microservice": microserviceSidebar,

diff --git a/docs/manuscripts/battle-interview/problems/Nginx面试.md b/docs/manuscripts/battle-interview/problems/Nginx面试.md
@@ -5,10 +5,6 @@ permalink: /manuscripts/battle-interview/nginx.html
 
 # Nginx面试
 
-[//]: # (```mindmap)
-[//]: # (root&#40;思维导图&#41;)
-[//]: # (  test)
-[//]: # (```)
 
 ## 什么是Nginx
 

diff --git a/docs/manuscripts/battle-interview/readme.md b/docs/manuscripts/battle-interview/readme.md
@@ -2,7 +2,7 @@
 
 ```mindmap
 root(Battle面试官)
-    面试题整理
-    面经分享
-    面试技巧
+    (面试题整理)
+    (面经分享)
+    (面试技巧)
 ```
diff --git a/docs/manuscripts/front-end/front-end.sidebar.ts b/docs/manuscripts/front-end/front-end.sidebar.ts
@@ -1,4 +1,4 @@
-export const frontEndSidebar = [
+export const FrontEndSidebar = [
   {
     text: 'HTML',
     link: 'base-begin/html.md'

diff --git a/docs/manuscripts/read-books/read-books.sidebar.ts b/docs/manuscripts/read-books/read-books.sidebar.ts
@@ -7,14 +7,14 @@ export const readBooksSidebar = [
         text: 'ES6标准入门',
         link: 'ES6标准入门.md'
       },
-      {
-        text: '更了不起的Node.js ',
-        link: '狼书.md'
-      },
       {
         text: '了不起的Node.js',
         link: '了不起的Node.js.md'
       },
+      {
+        text: '更了不起的Node.js ',
+        link: '狼书.md'
+      },
       {
         text: '深入浅出Node.js',
         link: '深入浅出的Node.js.md'

diff --git a/docs/manuscripts/server-end/base/OAuth2.0协议.md b/docs/manuscripts/server-end/base/OAuth2.0协议.md
@@ -1,6 +1,6 @@
 ---
 title: OAuth2.0协议
-permalink: /manuscripts/server-end/oauth2.html
+permalink: /manuscripts/server-end/base/oauth2.html
 ---
 
 # OAuth2.0协议
diff --git a/docs/manuscripts/server-end/base/base.sidebar.ts b/docs/manuscripts/server-end/base/base.sidebar.ts
@@ -0,0 +1,22 @@
+export const BaseSidebar=[
+  {
+    text: 'RestFul风格',
+    link: 'restFul.md'
+  },
+  {
+    text: '接口规范',
+    link: '接口规范.md'
+  },
+  {
+    text: 'OAuth2.0协议',
+    link: 'OAuth2.0协议.md'
+  },
+  {
+    text: '会话信息',
+    link: '会话信息.md'
+  },
+  {
+    text: '远程调用',
+    link: '远程调用.md'
+  }
+]
diff --git a/docs/manuscripts/server-end/base/restFul.md b/docs/manuscripts/server-end/base/restFul.md
@@ -1,6 +1,6 @@
 ---
 title: RESTful接口
-permalink: /manuscripts/server-end/restful.html
+permalink: /manuscripts/server-end/base/restful.html
 ---
 
 # RESTful接口
diff --git a/docs/manuscripts/server-end/base/会话信息.md b/docs/manuscripts/server-end/base/会话信息.md
@@ -1,6 +1,6 @@
 ---
 title: 会话信息
-permalink: /manuscripts/server-end/session.html
+permalink: /manuscripts/server-end/base/session.html
 ---
 
 # 会话信息
diff --git a/docs/manuscripts/server-end/base/接口规范.md b/docs/manuscripts/server-end/base/接口规范.md
@@ -1,6 +1,6 @@
 ---
 title: 接口规范
-permalink: /manuscripts/server-end/interface-rules.html
+permalink: /manuscripts/server-end/base/interface-rules.html
 ---
 
 # 接口规范
diff --git a/docs/manuscripts/server-end/base/远程调用.md b/docs/manuscripts/server-end/base/远程调用.md
@@ -1,6 +1,6 @@
 ---
 title: 远程调用
-permalink: /manuscripts/server-end/rpc.html
+permalink: /manuscripts/server-end/base/rpc.html
 ---
 
 # 远程调用
diff --git a/docs/manuscripts/server-end/database/mongo/mongo.sidebar.ts b/docs/manuscripts/server-end/database/mongo/mongo.sidebar.ts
@@ -1,6 +1,11 @@
 export const mongoSideBar = [
   {
-    text: '基础安装',
-    link: 'install.md'
+    text: '使用教程',
+    children: [
+      {
+        text: '基础安装',
+        link: '基础安装.md'
+      }
+    ]
   }
 ]
diff --git a/docs/manuscripts/server-end/database/mongo/readme.md b/docs/manuscripts/server-end/database/mongo/readme.md
@@ -1,2 +1,5 @@
-
+---
+title: MongoDB
+permalink: /manuscripts/server-end/database/mongo
+---
 # MongoDB
diff --git a/...ipts/server-end/database/mongo/install.md → ...scripts/server-end/database/mongo/基础安装.md b/...ipts/server-end/database/mongo/install.md → ...scripts/server-end/database/mongo/基础安装.md
@@ -1,9 +1,9 @@
 ---
-title: Mongo简单部署
-permalink: /manuscripts/server-end/database/mongo/install.html
+title: 基础安装
+permalink: /manuscripts/server-end/database/mongo/base-install.html
 ---
 
-# Mongo简单部署
+# 基础安装
 
 > 在mac本地部署MongoDB数据库，用来进行yapi功能测试
 

diff --git a/docs/manuscripts/server-end/database/mysql/install.md b/docs/manuscripts/server-end/database/mysql/install.md
diff --git a/docs/manuscripts/server-end/database/mysql/mysql.sidebar.ts b/docs/manuscripts/server-end/database/mysql/mysql.sidebar.ts
@@ -1,6 +1,11 @@
 export const mySqlSideBar = [
   {
-    text: '基础安装',
-    link: 'install.md'
+    text: '使用教程',
+    children: [
+      {
+        text: '基础安装',
+        link: '基础安装.md'
+      }
+    ]
   }
 ]
diff --git a/docs/manuscripts/server-end/database/mysql/readme.md b/docs/manuscripts/server-end/database/mysql/readme.md
@@ -1,2 +1,5 @@
-
+---
+title: MySQL
+permalink: /manuscripts/server-end/database/mysql
+---
 # MySQL
diff --git a/docs/manuscripts/server-end/database/mysql/基础安装.md b/docs/manuscripts/server-end/database/mysql/基础安装.md
@@ -0,0 +1,6 @@
+---
+title: 基础安装
+permalink: /manuscripts/server-end/database/mysql/base-install.html
+---
+
+# 基础安装
diff --git a/docs/manuscripts/server-end/database/redis/redis.sidebar.ts b/docs/manuscripts/server-end/database/redis/redis.sidebar.ts
@@ -1,22 +1,27 @@
 export const redisSidebar = [
   {
-    text: '基础安装',
-    link: 'base-install.md'
-  },
-  {
-    text: '使用规范',
-    link: 'use-rule.md'
-  },
-  {
-    text: '主从模式',
-    link: 'master-slave.md'
-  },
-  {
-    text: '哨兵模式',
-    link: 'sentinel.md'
-  },
-  {
-    text: '集群模式',
-    link: 'cluster.md'
+    text: '使用教程',
+    children: [
+      {
+        text: '基础安装',
+        link: '基础安装.md'
+      },
+      {
+        text: '使用规范',
+        link: '使用规范.md'
+      },
+      {
+        text: '主从模式',
+        link: '主从模式.md'
+      },
+      {
+        text: '哨兵模式',
+        link: '哨兵模式.md'
+      },
+      {
+        text: '集群模式',
+        link: '集群模式.md'
+      }
+    ]
   }
 ]
diff --git a/...server-end/database/redis/master-slave.md → ...scripts/server-end/database/redis/主从模式.md b/...server-end/database/redis/master-slave.md → ...scripts/server-end/database/redis/主从模式.md
diff --git a/...pts/server-end/database/redis/use-rule.md → ...scripts/server-end/database/redis/使用规范.md b/...pts/server-end/database/redis/use-rule.md → ...scripts/server-end/database/redis/使用规范.md
diff --git a/...pts/server-end/database/redis/sentinel.md → ...scripts/server-end/database/redis/哨兵模式.md b/...pts/server-end/database/redis/sentinel.md → ...scripts/server-end/database/redis/哨兵模式.md
diff --git a/...server-end/database/redis/base-install.md → ...scripts/server-end/database/redis/基础安装.md b/...server-end/database/redis/base-install.md → ...scripts/server-end/database/redis/基础安装.md
diff --git a/...ipts/server-end/database/redis/cluster.md → ...scripts/server-end/database/redis/集群模式.md b/...ipts/server-end/database/redis/cluster.md → ...scripts/server-end/database/redis/集群模式.md
diff --git a/docs/manuscripts/server-end/framework/egg-learn.md b/docs/manuscripts/server-end/framework/egg-learn.md
diff --git a/docs/manuscripts/server-end/framework/egg/egg.sidebar.ts b/docs/manuscripts/server-end/framework/egg/egg.sidebar.ts
@@ -64,19 +64,19 @@ export const eggSidebar = [
       {
         text: 'egg-sequelize',
         link: 'egg-sequelize.md'
-      },
-      {
-        text: 'egg-sequelize-plus',
-        link: 'egg-sequelize-plus.md'
-      },
-      {
-        text: 'egg-grpc-client',
-        link: 'egg-grpc-client.md'
-      },
-      {
-        text: 'egg-grpc-server',
-        link: 'egg-grpc-server.md'
       }
+      // {
+      //   text: 'egg-sequelize-plus',
+      //   link: 'egg-sequelize-plus.md'
+      // },
+      // {
+      //   text: 'egg-grpc-client',
+      //   link: 'egg-grpc-client.md'
+      // },
+      // {
+      //   text: 'egg-grpc-server',
+      //   link: 'egg-grpc-server.md'
+      // }
     ]
   },
   {

diff --git a/docs/manuscripts/server-end/framework/egg/readme.md b/docs/manuscripts/server-end/framework/egg/readme.md
@@ -1 +1,5 @@
+---
+title: Egg.js框架
+permalink: /manuscripts/server-end/framework/egg-tutorial
+---
 # Egg框架
diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/中间件.md b/docs/manuscripts/server-end/framework/egg/tutorial/中间件.md
@@ -1,5 +1,6 @@
 ---
 title: 中间件
+permalink: /manuscripts/server-end/framework/egg-tutorial/middleware.html
 ---
 
 

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/定时任务.md b/docs/manuscripts/server-end/framework/egg/tutorial/定时任务.md
@@ -1,5 +1,6 @@
 ---
 title: 定时任务
+permalink: /manuscripts/server-end/framework/egg-tutorial/schedule.html
 ---
 
 

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/快速入门.md b/docs/manuscripts/server-end/framework/egg/tutorial/快速入门.md
@@ -1,5 +1,6 @@
 ---
 title: 快速入门
+permalink: /manuscripts/server-end/framework/egg-tutorial/quick-start.html
 ---
 
 手把手快速从0到1搭建一个基础的Egg.js应用

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/控制器和服务.md b/docs/manuscripts/server-end/framework/egg/tutorial/控制器和服务.md
@@ -1,5 +1,6 @@
 ---
 title: 控制器和服务
+permalink: /manuscripts/server-end/framework/egg-tutorial/controller-service.html
 ---
 
 在传统的MVC架构中，C可以理解为控制器Controller，而在Egg框架中服务是在控制器的下发中分层抽离出来的，因此这里一起总结一下。

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/框架对象.md b/docs/manuscripts/server-end/framework/egg/tutorial/框架对象.md
@@ -1,5 +1,6 @@
 ---
 title: 框架对象
+permalink: /manuscripts/server-end/framework/egg-tutorial/object.html
 ---
 
 在Egg框架中，包含了很多内置的基础对象，常用到的有：

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/框架拓展.md b/docs/manuscripts/server-end/framework/egg/tutorial/框架拓展.md
@@ -1,5 +1,6 @@
 ---
 title: 框架扩展
+permalink: /manuscripts/server-end/framework/egg-tutorial/extends.html
 ---
 
 框架提供了多种扩展点扩展自身的功能：

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/目录结构.md b/docs/manuscripts/server-end/framework/egg/tutorial/目录结构.md
@@ -1,5 +1,6 @@
 ---
 title: 目录结构
+permalink: /manuscripts/server-end/framework/egg-tutorial/category.html
 ---
 
 利用官方提供的指令`npm init egg --type=simple`可以得到egg项目模板，而实际的项目会比模板复杂一些、层次分明一点

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/简介.md b/docs/manuscripts/server-end/framework/egg/tutorial/简介.md
@@ -1,5 +1,6 @@
 ---
 title: 简单介绍
+permalink: /manuscripts/server-end/framework/egg-tutorial/introduce.html
 ---
 
 ## 简单介绍

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/路由的使用.md b/docs/manuscripts/server-end/framework/egg/tutorial/路由的使用.md
@@ -1,5 +1,6 @@
 ---
 title: 路由的使用
+permalink: /manuscripts/server-end/framework/egg-tutorial/router.html
 ---
 
 

diff --git a/docs/manuscripts/server-end/framework/egg/tutorial/配置和运行环境.md b/docs/manuscripts/server-end/framework/egg/tutorial/配置和运行环境.md
@@ -1,5 +1,6 @@
 ---
 title: 框架对象
+permalink: /manuscripts/server-end/framework/egg-tutorial/setting-running.html
 ---
 
 在Egg框架中，包含了很多内置的基础对象，常用到的有：

diff --git a/docs/manuscripts/server-end/framework/koa/tutorial/Application对象介绍.md b/docs/manuscripts/server-end/framework/koa/tutorial/Application对象介绍.md
@@ -0,0 +1 @@
+# Application应用对象
diff --git a/docs/manuscripts/server-end/framework/koa/tutorial/基本介绍.md b/docs/manuscripts/server-end/framework/koa/tutorial/基本介绍.md
@@ -0,0 +1,8 @@
+# 基本介绍
+
+> Koa 是一个新的 web 框架，由 Express 幕后的原班人马打造， 致力于成为 web 应用和 API 开发领域中的一个更小、更富有表现力、更健壮的基石。 通过利用 async 函数，Koa 帮你丢弃回调函数，并有力地增强错误处理。
+> Koa 并没有捆绑任何中间件， 而是提供了一套优雅的方法，帮助您快速而愉快地编写服务端应用程序。
+
+## 参考资料
+
+- 中文官网：<https://koa.bootcss.com/index.html#introduction>