From 1d6149fefe0f9278df78d3e5a8c419cd07c49b0b Mon Sep 17 00:00:00 2001 From: alinhu1 Date: Wed, 19 Mar 2025 22:30:40 +0800 Subject: [PATCH] docs: adjust docs --- docs/advance/_category_.json | 2 +- docs/full_guide/_category_.json | 8 ++++++++ docs/{ => full_guide}/html/_category_.json | 2 +- docs/{ => full_guide}/html/console.png | Bin docs/{ => full_guide}/html/get.png | Bin docs/{ => full_guide}/html/image.png | Bin docs/{ => full_guide}/html/index.png | Bin docs/{ => full_guide}/html/visit.md | 0 docs/{ => full_guide}/react/_category_.json | 2 +- docs/{ => full_guide}/react/react_todo_list.md | 4 ++-- docs/{ => full_guide}/react/react_ts.md | 0 docs/{ => full_guide}/react/result2.png | Bin docs/{ => full_guide}/vite/_category_.json | 2 +- docs/{ => full_guide}/vite/vite.md | 0 .../vite_vanilla_ts/_category_.json | 2 +- docs/{ => full_guide}/vite_vanilla_ts/result.png | Bin .../vite_vanilla_ts/vite_vanilla_ts.md | 2 +- docs/recipes/_category_.json | 7 +++++++ docs/{ => recipes}/docker/1.png | Bin docs/{ => recipes}/docker/2.png | Bin docs/{ => recipes}/docker/5.png | Bin docs/{ => recipes}/docker/6.png | Bin docs/{ => recipes}/docker/7.png | Bin docs/{ => recipes}/docker/8.png | Bin docs/{ => recipes}/docker/_category_.json | 0 docs/{ => recipes}/docker/install.md | 0 docs/{ => recipes}/docker/start.md | 0 docs/{ => recipes}/use_prisma/_category_.json | 0 docs/{ => recipes}/use_prisma/prisma.md | 2 +- docs/{ => recipes}/use_prisma/verify1.png | Bin docs/{ => recipes}/use_prisma/verify2.png | Bin docs/reference/_category_.json | 7 +++++++ docs/{ => reference}/deal/_category_.json | 2 +- docs/{ => reference}/deal/code.png | Bin docs/{ => reference}/deal/exception.md | 0 docs/{ => reference}/deal/json.png | Bin docs/{ => reference}/deal/marketplace.png | Bin docs/{ => reference}/deal/setting.png | Bin docs/{ => reference}/linux_alias/_category_.json | 2 +- docs/{ => reference}/linux_alias/alias.md | 0 docs/tools/_category_.json | 2 +- 41 files changed, 34 insertions(+), 12 deletions(-) create mode 100644 docs/full_guide/_category_.json rename docs/{ => full_guide}/html/_category_.json (83%) rename docs/{ => full_guide}/html/console.png (100%) rename docs/{ => full_guide}/html/get.png (100%) rename docs/{ => full_guide}/html/image.png (100%) rename docs/{ => full_guide}/html/index.png (100%) rename docs/{ => full_guide}/html/visit.md (100%) rename docs/{ => full_guide}/react/_category_.json (81%) rename docs/{ => full_guide}/react/react_todo_list.md (97%) rename docs/{ => full_guide}/react/react_ts.md (100%) rename docs/{ => full_guide}/react/result2.png (100%) rename docs/{ => full_guide}/vite/_category_.json (81%) rename docs/{ => full_guide}/vite/vite.md (100%) rename docs/{ => full_guide}/vite_vanilla_ts/_category_.json (81%) rename docs/{ => full_guide}/vite_vanilla_ts/result.png (100%) rename docs/{ => full_guide}/vite_vanilla_ts/vite_vanilla_ts.md (97%) create mode 100644 docs/recipes/_category_.json rename docs/{ => recipes}/docker/1.png (100%) rename docs/{ => recipes}/docker/2.png (100%) rename docs/{ => recipes}/docker/5.png (100%) rename docs/{ => recipes}/docker/6.png (100%) rename docs/{ => recipes}/docker/7.png (100%) rename docs/{ => recipes}/docker/8.png (100%) rename docs/{ => recipes}/docker/_category_.json (100%) rename docs/{ => recipes}/docker/install.md (100%) rename docs/{ => recipes}/docker/start.md (100%) rename docs/{ => recipes}/use_prisma/_category_.json (100%) rename docs/{ => recipes}/use_prisma/prisma.md (95%) rename docs/{ => recipes}/use_prisma/verify1.png (100%) rename docs/{ => recipes}/use_prisma/verify2.png (100%) create mode 100644 docs/reference/_category_.json rename docs/{ => reference}/deal/_category_.json (82%) rename docs/{ => reference}/deal/code.png (100%) rename docs/{ => reference}/deal/exception.md (100%) rename docs/{ => reference}/deal/json.png (100%) rename docs/{ => reference}/deal/marketplace.png (100%) rename docs/{ => reference}/deal/setting.png (100%) rename docs/{ => reference}/linux_alias/_category_.json (81%) rename docs/{ => reference}/linux_alias/alias.md (100%) diff --git a/docs/advance/_category_.json b/docs/advance/_category_.json index 02cea3d..1f050bd 100644 --- a/docs/advance/_category_.json +++ b/docs/advance/_category_.json @@ -1,6 +1,6 @@ { "label": "高级教程", - "position": 5, + "position": 6, "link": { "type": "generated-index" } diff --git a/docs/full_guide/_category_.json b/docs/full_guide/_category_.json new file mode 100644 index 0000000..63f47a0 --- /dev/null +++ b/docs/full_guide/_category_.json @@ -0,0 +1,8 @@ +{ + "label": "完整指南", + "position": 3, + "link": { + "type": "generated-index" + } + } + \ No newline at end of file diff --git a/docs/html/_category_.json b/docs/full_guide/html/_category_.json similarity index 83% rename from docs/html/_category_.json rename to docs/full_guide/html/_category_.json index 35dfe31..808b396 100644 --- a/docs/html/_category_.json +++ b/docs/full_guide/html/_category_.json @@ -1,6 +1,6 @@ { "label": "访问HTML网页的流程", - "position": 11, + "position": 1, "link": { "type": "generated-index" } diff --git a/docs/html/console.png b/docs/full_guide/html/console.png similarity index 100% rename from docs/html/console.png rename to docs/full_guide/html/console.png diff --git a/docs/html/get.png b/docs/full_guide/html/get.png similarity index 100% rename from docs/html/get.png rename to docs/full_guide/html/get.png diff --git a/docs/html/image.png b/docs/full_guide/html/image.png similarity index 100% rename from docs/html/image.png rename to docs/full_guide/html/image.png diff --git a/docs/html/index.png b/docs/full_guide/html/index.png similarity index 100% rename from docs/html/index.png rename to docs/full_guide/html/index.png diff --git a/docs/html/visit.md b/docs/full_guide/html/visit.md similarity index 100% rename from docs/html/visit.md rename to docs/full_guide/html/visit.md diff --git a/docs/react/_category_.json b/docs/full_guide/react/_category_.json similarity index 81% rename from docs/react/_category_.json rename to docs/full_guide/react/_category_.json index 359db7a..57c4274 100644 --- a/docs/react/_category_.json +++ b/docs/full_guide/react/_category_.json @@ -1,6 +1,6 @@ { "label": "react的入门", - "position": 13, + "position": 4, "link": { "type": "generated-index" } diff --git a/docs/react/react_todo_list.md b/docs/full_guide/react/react_todo_list.md similarity index 97% rename from docs/react/react_todo_list.md rename to docs/full_guide/react/react_todo_list.md index 33211fc..c605345 100644 --- a/docs/react/react_todo_list.md +++ b/docs/full_guide/react/react_todo_list.md @@ -1,5 +1,5 @@ --- -sidebar_position: 1 +sidebar_position: 2 --- # 如何使用react+ts编写前端todo list @@ -9,7 +9,7 @@ sidebar_position: 1 1. 已创建react ts工程 >**提示** -若未创建react ts工程，可以参考[使用vite创建react ts工程](http://localhost:3000/full-stack-tutorial/docs/react/react_ts)文档 +若未创建react ts工程，可以参考[使用vite创建react ts工程](https://github.com/idealjs/full-stack-tutorial/blob/main/docs/react/react_ts.md)文档 ## 项目初始化 打开react ts工程 diff --git a/docs/react/react_ts.md b/docs/full_guide/react/react_ts.md similarity index 100% rename from docs/react/react_ts.md rename to docs/full_guide/react/react_ts.md diff --git a/docs/react/result2.png b/docs/full_guide/react/result2.png similarity index 100% rename from docs/react/result2.png rename to docs/full_guide/react/result2.png diff --git a/docs/vite/_category_.json b/docs/full_guide/vite/_category_.json similarity index 81% rename from docs/vite/_category_.json rename to docs/full_guide/vite/_category_.json index 1db060f..a28cfe6 100644 --- a/docs/vite/_category_.json +++ b/docs/full_guide/vite/_category_.json @@ -1,6 +1,6 @@ { "label": "vite的入门", - "position": 10, + "position": 2, "link": { "type": "generated-index" } diff --git a/docs/vite/vite.md b/docs/full_guide/vite/vite.md similarity index 100% rename from docs/vite/vite.md rename to docs/full_guide/vite/vite.md diff --git a/docs/vite_vanilla_ts/_category_.json b/docs/full_guide/vite_vanilla_ts/_category_.json similarity index 81% rename from docs/vite_vanilla_ts/_category_.json rename to docs/full_guide/vite_vanilla_ts/_category_.json index 2a6ab1e..3cb3d77 100644 --- a/docs/vite_vanilla_ts/_category_.json +++ b/docs/full_guide/vite_vanilla_ts/_category_.json @@ -1,6 +1,6 @@ { "label": "vanilla ts工程", - "position": 12, + "position": 3, "link": { "type": "generated-index" } diff --git a/docs/vite_vanilla_ts/result.png b/docs/full_guide/vite_vanilla_ts/result.png similarity index 100% rename from docs/vite_vanilla_ts/result.png rename to docs/full_guide/vite_vanilla_ts/result.png diff --git a/docs/vite_vanilla_ts/vite_vanilla_ts.md b/docs/full_guide/vite_vanilla_ts/vite_vanilla_ts.md similarity index 97% rename from docs/vite_vanilla_ts/vite_vanilla_ts.md rename to docs/full_guide/vite_vanilla_ts/vite_vanilla_ts.md index e98b35e..88212fc 100644 --- a/docs/vite_vanilla_ts/vite_vanilla_ts.md +++ b/docs/full_guide/vite_vanilla_ts/vite_vanilla_ts.md @@ -7,7 +7,7 @@ sidebar_position: 1 1. 已创建vanilla ts工程 >**提示** -若未安装vanilla ts工程，可以参考[vite的入门](http://localhost:3000/full-stack-tutorial/docs/vite)文档 +若未安装vanilla ts工程，可以参考[vite的入门](https://github.com/idealjs/full-stack-tutorial/blob/main/docs/vite/vite.md)文档 ## 项目初始化 打开vanilla ts工程 diff --git a/docs/recipes/_category_.json b/docs/recipes/_category_.json new file mode 100644 index 0000000..71792a7 --- /dev/null +++ b/docs/recipes/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "操作指南", + "position": 4, + "link": { + "type": "generated-index" + } + } \ No newline at end of file diff --git a/docs/docker/1.png b/docs/recipes/docker/1.png similarity index 100% rename from docs/docker/1.png rename to docs/recipes/docker/1.png diff --git a/docs/docker/2.png b/docs/recipes/docker/2.png similarity index 100% rename from docs/docker/2.png rename to docs/recipes/docker/2.png diff --git a/docs/docker/5.png b/docs/recipes/docker/5.png similarity index 100% rename from docs/docker/5.png rename to docs/recipes/docker/5.png diff --git a/docs/docker/6.png b/docs/recipes/docker/6.png similarity index 100% rename from docs/docker/6.png rename to docs/recipes/docker/6.png diff --git a/docs/docker/7.png b/docs/recipes/docker/7.png similarity index 100% rename from docs/docker/7.png rename to docs/recipes/docker/7.png diff --git a/docs/docker/8.png b/docs/recipes/docker/8.png similarity index 100% rename from docs/docker/8.png rename to docs/recipes/docker/8.png diff --git a/docs/docker/_category_.json b/docs/recipes/docker/_category_.json similarity index 100% rename from docs/docker/_category_.json rename to docs/recipes/docker/_category_.json diff --git a/docs/docker/install.md b/docs/recipes/docker/install.md similarity index 100% rename from docs/docker/install.md rename to docs/recipes/docker/install.md diff --git a/docs/docker/start.md b/docs/recipes/docker/start.md similarity index 100% rename from docs/docker/start.md rename to docs/recipes/docker/start.md diff --git a/docs/use_prisma/_category_.json b/docs/recipes/use_prisma/_category_.json similarity index 100% rename from docs/use_prisma/_category_.json rename to docs/recipes/use_prisma/_category_.json diff --git a/docs/use_prisma/prisma.md b/docs/recipes/use_prisma/prisma.md similarity index 95% rename from docs/use_prisma/prisma.md rename to docs/recipes/use_prisma/prisma.md index cdf6acb..6cf50aa 100644 --- a/docs/use_prisma/prisma.md +++ b/docs/recipes/use_prisma/prisma.md @@ -13,7 +13,7 @@ sidebar_position: 1 5. 确认已启动数据库 >**提示** -如果不知道怎么启动数据库，可以参考使用 [Docker启动数据库](http://localhost:3000/full-stack-tutorial/docs/docker/start)文档 +如果不知道怎么启动数据库，可以参考使用 [Docker启动数据库](https://github.com/idealjs/full-stack-tutorial/blob/main/docs/docker/start.md)文档 ## 项目初始化 - 打开Next.js项目 diff --git a/docs/use_prisma/verify1.png b/docs/recipes/use_prisma/verify1.png similarity index 100% rename from docs/use_prisma/verify1.png rename to docs/recipes/use_prisma/verify1.png diff --git a/docs/use_prisma/verify2.png b/docs/recipes/use_prisma/verify2.png similarity index 100% rename from docs/use_prisma/verify2.png rename to docs/recipes/use_prisma/verify2.png diff --git a/docs/reference/_category_.json b/docs/reference/_category_.json new file mode 100644 index 0000000..5568a1f --- /dev/null +++ b/docs/reference/_category_.json @@ -0,0 +1,7 @@ +{ + "label": "参考资料", + "position":5, + "link": { + "type": "generated-index" + } + } \ No newline at end of file diff --git a/docs/deal/_category_.json b/docs/reference/deal/_category_.json similarity index 82% rename from docs/deal/_category_.json rename to docs/reference/deal/_category_.json index 057f51a..ca87ec7 100644 --- a/docs/deal/_category_.json +++ b/docs/reference/deal/_category_.json @@ -1,6 +1,6 @@ { "label": "vscode插件异常", - "position": 6, + "position": 1, "link": { "type": "generated-index" } diff --git a/docs/deal/code.png b/docs/reference/deal/code.png similarity index 100% rename from docs/deal/code.png rename to docs/reference/deal/code.png diff --git a/docs/deal/exception.md b/docs/reference/deal/exception.md similarity index 100% rename from docs/deal/exception.md rename to docs/reference/deal/exception.md diff --git a/docs/deal/json.png b/docs/reference/deal/json.png similarity index 100% rename from docs/deal/json.png rename to docs/reference/deal/json.png diff --git a/docs/deal/marketplace.png b/docs/reference/deal/marketplace.png similarity index 100% rename from docs/deal/marketplace.png rename to docs/reference/deal/marketplace.png diff --git a/docs/deal/setting.png b/docs/reference/deal/setting.png similarity index 100% rename from docs/deal/setting.png rename to docs/reference/deal/setting.png diff --git a/docs/linux_alias/_category_.json b/docs/reference/linux_alias/_category_.json similarity index 81% rename from docs/linux_alias/_category_.json rename to docs/reference/linux_alias/_category_.json index 954580a..33de59c 100644 --- a/docs/linux_alias/_category_.json +++ b/docs/reference/linux_alias/_category_.json @@ -1,6 +1,6 @@ { "label": "Alias命令", - "position": 9, + "position": 2, "link": { "type": "generated-index" } diff --git a/docs/linux_alias/alias.md b/docs/reference/linux_alias/alias.md similarity index 100% rename from docs/linux_alias/alias.md rename to docs/reference/linux_alias/alias.md diff --git a/docs/tools/_category_.json b/docs/tools/_category_.json index f080396..e015692 100644 --- a/docs/tools/_category_.json +++ b/docs/tools/_category_.json @@ -1,6 +1,6 @@ { "label": "工具", - "position": 3, + "position": 5, "link": { "type": "generated-index" }