From d9fbf121e5e4b3291e1902bb21c420c845b8eac6 Mon Sep 17 00:00:00 2001
From: zjx0905 <954270063@qq.com>
Date: Tue, 11 Apr 2023 16:10:23 +0800
Subject: [PATCH] =?UTF-8?q?docs:=20=E9=87=8D=E6=9E=84=20docs?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 CONTRIBUTING.md                               | 7 +++++++
 docs/.vitepress/config.ts                     | 1 +
 docs/{ => pages}/api/axios.md                 | 0
 docs/{ => pages}/api/cancel-token.md          | 0
 docs/{ => pages}/api/create.md                | 0
 docs/{ => pages}/api/get-uri.md               | 0
 docs/{ => pages}/api/interceptors.md          | 0
 docs/{ => pages}/api/is-axios-error.md        | 0
 docs/{ => pages}/api/is-cancel.md             | 0
 docs/{ => pages}/config/adapter.md            | 0
 docs/{ => pages}/config/data-type.md          | 0
 docs/{ => pages}/config/download.md           | 0
 docs/{ => pages}/config/error-handler.md      | 0
 docs/{ => pages}/config/method.md             | 0
 docs/{ => pages}/config/params-serializer.md  | 0
 docs/{ => pages}/config/preview.md            | 0
 docs/{ => pages}/config/response-type.md      | 0
 docs/{ => pages}/config/transform-request.md  | 0
 docs/{ => pages}/config/transform-response.md | 0
 docs/{ => pages}/config/upload.md             | 0
 docs/{ => pages}/config/validate-status.md    | 0
 docs/{ => pages}/guide/introduction.md        | 0
 docs/{ => pages}/guide/quick-start.md         | 0
 docs/{ => pages}/index.md                     | 0
 24 files changed, 8 insertions(+)
 rename docs/{ => pages}/api/axios.md (100%)
 rename docs/{ => pages}/api/cancel-token.md (100%)
 rename docs/{ => pages}/api/create.md (100%)
 rename docs/{ => pages}/api/get-uri.md (100%)
 rename docs/{ => pages}/api/interceptors.md (100%)
 rename docs/{ => pages}/api/is-axios-error.md (100%)
 rename docs/{ => pages}/api/is-cancel.md (100%)
 rename docs/{ => pages}/config/adapter.md (100%)
 rename docs/{ => pages}/config/data-type.md (100%)
 rename docs/{ => pages}/config/download.md (100%)
 rename docs/{ => pages}/config/error-handler.md (100%)
 rename docs/{ => pages}/config/method.md (100%)
 rename docs/{ => pages}/config/params-serializer.md (100%)
 rename docs/{ => pages}/config/preview.md (100%)
 rename docs/{ => pages}/config/response-type.md (100%)
 rename docs/{ => pages}/config/transform-request.md (100%)
 rename docs/{ => pages}/config/transform-response.md (100%)
 rename docs/{ => pages}/config/upload.md (100%)
 rename docs/{ => pages}/config/validate-status.md (100%)
 rename docs/{ => pages}/guide/introduction.md (100%)
 rename docs/{ => pages}/guide/quick-start.md (100%)
 rename docs/{ => pages}/index.md (100%)

diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index ef6160b..4bd2b46 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -24,6 +24,13 @@ pnpm docs:dev
 pnpm test:watch
 ```
 
+我们使用 cz-git 以交互式完成 git commit。
+
+```bash
+git add .
+pnpm cz
+```
+
 ## 贡献
 
 ### 现有功能
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 4487a8e..bbd5459 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -4,6 +4,7 @@ import { defineConfig } from 'vitepress';
 export default defineConfig({
   title: 'axios-miniprogram',
   description: '基于 Promise 的 HTTP 请求库，适用于各大小程序平台。',
+  srcDir: 'pages',
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [
diff --git a/docs/api/axios.md b/docs/pages/api/axios.md
similarity index 100%
rename from docs/api/axios.md
rename to docs/pages/api/axios.md
diff --git a/docs/api/cancel-token.md b/docs/pages/api/cancel-token.md
similarity index 100%
rename from docs/api/cancel-token.md
rename to docs/pages/api/cancel-token.md
diff --git a/docs/api/create.md b/docs/pages/api/create.md
similarity index 100%
rename from docs/api/create.md
rename to docs/pages/api/create.md
diff --git a/docs/api/get-uri.md b/docs/pages/api/get-uri.md
similarity index 100%
rename from docs/api/get-uri.md
rename to docs/pages/api/get-uri.md
diff --git a/docs/api/interceptors.md b/docs/pages/api/interceptors.md
similarity index 100%
rename from docs/api/interceptors.md
rename to docs/pages/api/interceptors.md
diff --git a/docs/api/is-axios-error.md b/docs/pages/api/is-axios-error.md
similarity index 100%
rename from docs/api/is-axios-error.md
rename to docs/pages/api/is-axios-error.md
diff --git a/docs/api/is-cancel.md b/docs/pages/api/is-cancel.md
similarity index 100%
rename from docs/api/is-cancel.md
rename to docs/pages/api/is-cancel.md
diff --git a/docs/config/adapter.md b/docs/pages/config/adapter.md
similarity index 100%
rename from docs/config/adapter.md
rename to docs/pages/config/adapter.md
diff --git a/docs/config/data-type.md b/docs/pages/config/data-type.md
similarity index 100%
rename from docs/config/data-type.md
rename to docs/pages/config/data-type.md
diff --git a/docs/config/download.md b/docs/pages/config/download.md
similarity index 100%
rename from docs/config/download.md
rename to docs/pages/config/download.md
diff --git a/docs/config/error-handler.md b/docs/pages/config/error-handler.md
similarity index 100%
rename from docs/config/error-handler.md
rename to docs/pages/config/error-handler.md
diff --git a/docs/config/method.md b/docs/pages/config/method.md
similarity index 100%
rename from docs/config/method.md
rename to docs/pages/config/method.md
diff --git a/docs/config/params-serializer.md b/docs/pages/config/params-serializer.md
similarity index 100%
rename from docs/config/params-serializer.md
rename to docs/pages/config/params-serializer.md
diff --git a/docs/config/preview.md b/docs/pages/config/preview.md
similarity index 100%
rename from docs/config/preview.md
rename to docs/pages/config/preview.md
diff --git a/docs/config/response-type.md b/docs/pages/config/response-type.md
similarity index 100%
rename from docs/config/response-type.md
rename to docs/pages/config/response-type.md
diff --git a/docs/config/transform-request.md b/docs/pages/config/transform-request.md
similarity index 100%
rename from docs/config/transform-request.md
rename to docs/pages/config/transform-request.md
diff --git a/docs/config/transform-response.md b/docs/pages/config/transform-response.md
similarity index 100%
rename from docs/config/transform-response.md
rename to docs/pages/config/transform-response.md
diff --git a/docs/config/upload.md b/docs/pages/config/upload.md
similarity index 100%
rename from docs/config/upload.md
rename to docs/pages/config/upload.md
diff --git a/docs/config/validate-status.md b/docs/pages/config/validate-status.md
similarity index 100%
rename from docs/config/validate-status.md
rename to docs/pages/config/validate-status.md
diff --git a/docs/guide/introduction.md b/docs/pages/guide/introduction.md
similarity index 100%
rename from docs/guide/introduction.md
rename to docs/pages/guide/introduction.md
diff --git a/docs/guide/quick-start.md b/docs/pages/guide/quick-start.md
similarity index 100%
rename from docs/guide/quick-start.md
rename to docs/pages/guide/quick-start.md
diff --git a/docs/index.md b/docs/pages/index.md
similarity index 100%
rename from docs/index.md
rename to docs/pages/index.md