From 2b88f5266152ab79ecafbe1123a7f34f067c2d04 Mon Sep 17 00:00:00 2001
From: fanyushun <fanyushun@yunwutech.com>
Date: Fri, 12 Jul 2024 11:28:20 +0800
Subject: [PATCH] =?UTF-8?q?feat:=20=E6=B7=BB=E5=8A=A0=E8=AF=B4=E6=98=8E?=
 =?UTF-8?q?=E6=96=87=E6=A1=A3?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 README.md                  | 38 ++++++++++++++++++++++++++++++++++++-
 docs/.vitepress/config.ts  |  1 +
 docs/index.md              |  9 +++++++--
 docs/introduction/index.md | 39 ++++++++++++++++++++++++++++++++++++++
 4 files changed, 84 insertions(+), 3 deletions(-)
 create mode 100644 docs/introduction/index.md

diff --git a/README.md b/README.md
index 45fe7f9..64f5771 100644
--- a/README.md
+++ b/README.md
@@ -1,3 +1,39 @@
 # fxss-leetcode 算法
 
-leetcode 算法
+leetcode 算法集用于记录 leetcode 算法和平常想到的一些算法题，可以在 test 目录使用 vitest 测试，并以 vitepress 文档进行展示。
+
+安装项目：
+
+```sh
+npm i
+```
+
+测试算法：
+
+```sh
+npm run test
+```
+
+文档展示：
+
+```sh
+npm run docs:dev
+```
+
+由于每次需要创建的文档比较多，所以专门增加了命令行创建、删除文件：
+
+创建文件：
+
+```sh
+npm run add
+```
+
+按照命令行输入选择，可以直接创建代码段文件、测试文件、文档文件。leetcode 代码段标题以数字序号开头的，会自动排序。
+
+删除文件：
+
+```sh
+npm run rm
+```
+
+按照命令行输入选择，删除所有相关文件。
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
index 0f2f84e..84d4492 100644
--- a/docs/.vitepress/config.ts
+++ b/docs/.vitepress/config.ts
@@ -50,6 +50,7 @@ export default defineConfig({
     // https://vitepress.dev/reference/default-theme-config
     nav: [
       { text: '主页', link: '/' },
+      { text: '项目简介', link: '/introduction/' },
       { text: 'leetcode', link: '/leetcode/' },
       { text: '其他', link: '/other/' },
       { text: '泛积木-低代码', link: 'https://www.fxss.work/' },
diff --git a/docs/index.md b/docs/index.md
index d9d753d..547a7ea 100644
--- a/docs/index.md
+++ b/docs/index.md
@@ -8,7 +8,12 @@ hero:
   tagline: leetcode 算法
   actions:
     - theme: brand
-      text: 快速开始
+      text: 项目简介
+      link: /introduction/
+    - theme: alt
+      text: leetcode
       link: /leetcode/
+    - theme: alt
+      text: 其他
+      link: /other/
 ---
-
diff --git a/docs/introduction/index.md b/docs/introduction/index.md
new file mode 100644
index 0000000..f463256
--- /dev/null
+++ b/docs/introduction/index.md
@@ -0,0 +1,39 @@
+# leetcode 算法集
+
+leetcode 算法集用于记录 leetcode 算法和平常想到的一些算法题，可以在 test 目录使用 vitest 测试，并以 vitepress 文档进行展示。
+
+安装项目：
+
+```sh
+npm i
+```
+
+测试算法：
+
+```sh
+npm run test
+```
+
+文档展示：
+
+```sh
+npm run docs:dev
+```
+
+由于每次需要创建的文档比较多，所以专门增加了命令行创建、删除文件：
+
+创建文件：
+
+```sh
+npm run add
+```
+
+按照命令行输入选择，可以直接创建代码段文件、测试文件、文档文件。leetcode 代码段标题以数字序号开头的，会自动排序。
+
+删除文件：
+
+```sh
+npm run rm
+```
+
+按照命令行输入选择，删除所有相关文件。