From 5fe34f8b876a56095f13bebf40141617fb4f6606 Mon Sep 17 00:00:00 2001
From: jiangzhixiong <710328466@qq.com>
Date: Wed, 15 May 2024 11:18:44 +0800
Subject: [PATCH] =?UTF-8?q?fix:=20=E6=B7=BB=E5=8A=A0=E9=A6=96=E9=A1=B5?=
MIME-Version: 1.0
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 8bit

---
 docs/index.md | 159 ++++++++++++++++++++++++++++++++++++++++++++++++++
 1 file changed, 159 insertions(+)
 create mode 100644 docs/index.md

diff --git a/docs/index.md b/docs/index.md
new file mode 100644
index 0000000..3255e9f
--- /dev/null
+++ b/docs/index.md
@@ -0,0 +1,159 @@
+---
+hero:
+  title: lambo
+  description: 致力于提升前端开发效率与规范
+  actions:
+    - text: 快速上手
+      link: /bizs
+features:
+  - title: biz
+    emoji: 🍑
+    description: 业务库
+  - title: hooks
+    emoji: 💎
+    description: hooks
+  - title: func
+    emoji: 🌈
+    description: 常用函数库
+  - title: meta
+    emoji: ☀️
+    description: 原子组件库
+  - title: constants
+    emoji: 🈶️
+    description: 静态定义库
+  - title: request
+    emoji: 🥣
+    description: 网络请求库
+  - title: types
+    emoji: 🈸
+    description: typescript 声明库
+  - title: material
+    emoji: 🥱
+    description: 物料库
+  - title: cli
+    emoji: 🐔
+    description: 脚手架
+---
+
+## 目录结构
+
+<Tree>
+  <ul>
+    <li>
+      docs
+      <small>全局文档</small>
+      <ul>
+        <li>
+          index.md
+          <small>这是首页文档</small>
+        </li>
+      </ul>
+    </li>
+    <li>
+      packages
+      <small>组件包目录</small>
+      <ul>
+        <li>
+          biz
+          <small>业务组件</small>
+        </li>
+        <li>
+          func
+          <small>函数库</small>
+        </li>
+        <li>
+          hooks
+          <small>hooks</small>
+        </li>
+        <li>
+          constants
+          <small>静态枚举值定义</small>
+        </li>
+        <li>
+          meta
+          <small>元组件</small>
+        </li>
+        <li>
+          request
+          <small>请求库</small>
+        </li>
+        <li>
+          types
+          <small>类型定义库</small>
+        </li>
+        <li>
+          material
+          <small>物料库</small>
+        </li>
+        <li>
+          cli
+          <small>脚手架</small>
+        </li>
+      </ul>
+    </li>
+    <li>
+      src
+      <small>这是 src 文件夹</small>
+      <ul>
+        <li>
+          index.md
+          <small>这是 index.md</small>
+        </li>
+      </ul>
+    </li>
+    <li>
+      .dumirc.ts
+      <small>文档配置</small>
+    </li>
+    <li>
+      package.json
+      <small>这是 package.json</small>
+    </li>
+  </ul>
+</Tree>
+
+## 本文档食用说明
+
+目前在进行中的项目为：@zhst/bizs、@zhst/hooks、@zhst/meta、@zhst/func..
+
+bizs: 基于@zhst/hooks、@zhst/meta、@zhst/func 开发，基本贴近于业务。<Badge>doing</Badge>
+
+meta：基于 antd 开发，作为公司的定制化原子组件。<Badge>doing</Badge>
+
+hooks：基于 ahooks、@zhst/func 定制化二次开发。<Badge>doing</Badge>
+
+func：基于 lodash-es 定制化二次开发 (由于 utils 包名被使用了)<Badge>doing</Badge>
+
+## 后续构思
+
+想做一个，基于智慧视通开发场景和业务场景的前端技术流程化方案，希望它能渗透到整个研发的所有流程中。
+
+比如：代码规范、git 提交规范、物料库、基于 electron 的前端工具客户端（可集成物料库、图片上传小工具）、api 自动生成...
+
+:::info{title=@zhst/lint}
+lint 工具库，包含：eslint-config、eslint-plugin、commit-lint
+:::
+
+:::info{title=@zhst/metarial}
+物料库，可以直接通过 clone npm 仓库的形式生成模板页面，页面没有任何依赖，一个页面就是一个项目。
+:::
+
+:::info{title=@zhst/app}
+基于 electron 的前端客户端工具，初期功能构思方案有：文件上传、git 仓库管理、物料库可视化页面一键生成
+:::
+
+:::info{title=@zhst/autoapi}
+接口一键生成工具
+:::
+
+:::info{title=@types/zhst}
+类型定义库
+:::
+
+:::info{title=@zhst/constants}
+静态变量枚举库
+:::
+
+:::info{title=@zhst/cli}
+基于物料库的脚手架，可以直接通过可视化界面搭建项目，偏向于 lowcode+ 思维
+:::