refactor: 工具使用改为独立 docs 实例,路由从 /docs/tools 迁移到 /tools

- docs/tools 移至 packages/stack-idealjs/tools
- 新增 @docusaurus/plugin-content-docs tools 实例与 sidebarsTools.ts
- 导航栏"工具使用"指向独立侧边栏 toolsSidebar
- 修复 prisma 文档中的旧路径链接

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
cqh963852andCopilot committed 2026-08-19 14:20:50 +08:00
1 parent 43581b238c
commit 80268937ee
35 files changed
+26 -3

No files matched your search

@@ -1,7 +0,0 @@
{
"label": "工具使用",
"position": 4,
"link": {
"type": "generated-index"
}
}
Binary file not shown.

Before

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 52 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 71 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 68 KiB

@@ -1,7 +0,0 @@
{
"label": "Docker",
"position": 4,
"link": {
"type": "generated-index"
}
}
@@ -1,48 +0,0 @@
---
sidebar_position: 1
---
# docker的安装与验证
docker是一种开源平台,用于开发、部署和运行应用程序。
## 先决条件
1. 确保您的系统是windows专业版
2. 已安装了wsl2
>**提示**
如果没有安装wsl2,可以参考[安装wsl文档](https://learn.microsoft.com/zh-cn/windows/wsl/install)
## docker的安装
### 1. 开启windows功能
通过控制面板,开启Hyper-v和适用于windows子系统功能
![控制面板](./1.png)
![启动windows功能](./2.png)
### 2. 下载并安装docker
下载docker最安全的路径就是去官网,安装时要注意勾选`wsl`选项,安装成功后跳过登录docker Hub账号
```
https://docs.docker.com/desktop/install/windows-install/
```
## 配置Docker镜像
安装docker后,进入docker,开始配置镜像
![设置页面](./6.png)
![Docker Engine](./7.png)
配置镜像添加以下内容
```
"registry-mirrors":["https://docker.m.daocloud.io","https://docker.1panel.live"]
```
## 验证Docker
运行以下命令,测试Docker是否正确安装并运行
```
docker run hello-world
```
当输出`Hello from Docker`命令时,表明Docker安装正确
![验证Docker](./8.png)
@@ -1,64 +0,0 @@
---
sidebar_position: 1
---
# Docker启动数据库
使用Docker启动PostgreSQL数据库
## 先决条件
1. 已安装Docker
2. 以wsl为开发环境
## 拉取 PostgreSQL 镜像
在wsl中,运行以下命令来拉取 `PostgreSQL` 镜像:
```
sudo docker pull postgres
```
## 创建文件并启动容器
### 1. 创建`docker-compose.yml`文件
运行以下命令,创建`docker-compose.yml`文件
```
touch docker-compose.yml
```
### 2. 编写文件
在`docker-compose.yml`文件中,写入以下内容:
```
version: '3.9'
services:
db:
image: postgres
restart: always
shm_size: 128mb
environment:
POSTGRES_PASSWORD: example
ports:
- "5432:5432"
adminer:
image: adminer
restart: always
ports:
- 7897:8080
```
### 3. 启动`PostgreSQL`数据库
运行以下命令启动`PostgreSQL`数据库:
```
docker-compose up --build
```
### 4. 验证启动
运行以下命令`ps`,当STATUS出现`up`的时候,容器就表示启动成功
```
docker ps
```
![运行容器](./5.png)
### 5. 连接到PostgreSQL数据库
运行以下命令,连接到PostgreSQL数据库:
```
docker exec -it my-postgres psql -U postgres
```
@@ -1,7 +0,0 @@
{
"label": "Git",
"position": 2,
"link": {
"type": "generated-index"
}
}
@@ -1,119 +0,0 @@
---
sidebar_position: 1
---
import Tabs from "@theme/Tabs";
import TabItem from "@theme/TabItem";
# Git
git 是一个代码管理工具,可以追踪代码的提交记录。这是每个软件工程师必备工具,没有之一。
## 安装
工欲善其事,必先利其器。
<Tabs
defaultValue="win"
values={[
{ label: "win", value: "win" },
{ label: "ubuntu", value: "ubuntu" },
{ label: "mac", value: "mac" },
]}
>
<TabItem value="win">
下载地址 https://git-scm.com/
</TabItem>
<TabItem value="ubuntu">
大部分linux系统都自带git,打开控制台输入 git --version 查看 git 版本
</TabItem>
<TabItem value="mac">
mac系统自带git,打开控制台输入 git --version 查看 git 版本
</TabItem>
</Tabs>
## 使用
通常一个项目会对应一个 git 仓库,每次提交代码都会记录到 git 仓库中,这样就可以追踪代码的提交记录。
用图形化的工具来看的话,会呈现出如下图
![预览效果](./post-1-1.png)
### 克隆
克隆可以理解为将代码仓库复制了一份。
以此代码仓库为例,实际操作一下
```
git clone https://github.com/idealjs/stack.git
```
后面的地址我们可以在 github 上看到,但是需要选用 https 的地址。
因为 ssh 地址需要做一些配置,所以先用 https 的地址克隆。
被克隆的仓库,我们通常叫他 **远程仓库**。或者源仓库。
![预览效果](./post-1-2.png)
### 拉取代码
刚克隆下的代码可能是最新的,但是过一段时间如果有人推送了新的提交到远程仓库,那么本地仓库如何同步远程仓库呢。
输入如下命令
```
git pull
```
### 推送代码
修改后的代码,想要共享给其他人,要如何做?
在 git 中,可以推送的东西只有修改记录。
而修改记录是不会因为文件被更改,就自动生成的,我们需要通过 git 工具把文件修改记录下来。
用如下命令把所有的修改都记录下。
```
git add .
```
然后提交到本地仓库
```
git commit -m "test"
```
最后把新的提交记录推送到远程仓库
```
git push
```
## vscode插件:Git Graph
命令行适合执行 git 操作,但查看提交历史、分支结构时,图形化工具更直观。
推荐在 vscode 中安装 **Git Graph** 插件。
### 安装
1. 打开vscode,进入扩展面板(快捷键`Ctrl + Shift + X`)
2. 搜索`Git Graph`
3. 点击安装
### 使用
安装后,在资源管理器中右键 git 仓库,选择`Git Graph: View Git Graph`,即可看到图形化的提交历史。
主要功能
- 查看分支、合并记录的可视化图谱
- 查看每次提交的变更文件与代码差异
- 直接在界面上执行 checkout、merge、rebase、创建分支等操作
Binary file not shown.

Before

Width:  |  Height:  |  Size: 61 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

@@ -1,19 +0,0 @@
---
sidebar_position: 1
---
# 工具使用
本章节为 **本地工具** 教程,需要读者在自己的电脑上安装、配置并实践操作。
与在线教程不同,这些内容无法仅通过阅读掌握,请务必在本地环境中跟随练习。
## 内容
1. [安装工具(nodejs、vscode)](./install/nodejs.md)
2. [Git](./git/index.mdx)
3. [NVM](./nvm/install_nvm.md)
4. [Docker](./docker/install.md)
5. [Prisma](./prisma/prisma.md)
6. [VSCode 常见问题](./vscode/exception)
7. [Linux Alias](./linux/alias.md)
@@ -1,7 +0,0 @@
{
"label": "安装工具-win",
"position": 1,
"link": {
"type": "generated-index"
}
}
@@ -1,17 +0,0 @@
---
sidebar_position: 2
---
# 安装 nodejs
访问网站 https://nodejs.org/zh-cn/
点击下载长期维护版 并且安装
全默认选项安装
> 安装完成重启电脑,使环境变量生效。
## 为什么需要 nodejs
1. nodejs 可以用来启动简单的 http 服务
2. nodejs 可以用来构建模块化的工程
@@ -1,13 +0,0 @@
---
sidebar_position: 1
---
# 安装 vscode 编辑器
访问网站 https://code.visualstudio.com/
点击下载并且安装
## 下载速度慢
参考 https://zhuanlan.zhihu.com/p/112215618
@@ -1,7 +0,0 @@
{
"label": "Linux",
"position": 7,
"link": {
"type": "generated-index"
}
}
@@ -1,41 +0,0 @@
---
sidebar_position: 1
---
# Linux alias
在Linux中,`alias`是一个用于创建命令别名的内置命令;通过`alias`,可以把常用的命令或命令组合设置为简短的别名,从而简化操作。
## 使用方法
### 1. 创建别名
运行以下命令:
```
alias 别名='命令'
```
例如:
```
alias ll='ls -l'
```
在命令行中输入`ll`就相当于输入`ls-l`
### 2. 永久别名
在`~/.bashrc`或者`~/.zshrc`文件中配置以下内容:
```
alias ll='ls -l'
```
### 3. 查看别名
在命令行中输入以下命令:
```
alias
```
### 4. 删除别名
在命令行中输入以下命令:
```
unalias 别名
```
例如:
```
unalias ll
```
这样ll别名就会被删除
@@ -1,7 +0,0 @@
{
"label": "NVM",
"position": 3,
"link": {
"type": "generated-index"
}
}
@@ -1,50 +0,0 @@
# nvm
- Node.js是用于服务器端JavaScript运行,适合高性能、实时应用
- NVM用于管理多个Node.js版本,便于在不同项目间切换
## 先决条件
1. 确保安装了Ubuntu
## 安装NVM
### 1. 安装cURL
在wsl中,运行以下命令:`install`
```
sudo apt-get install curl
```
### 2. 安装nvm
通过curl安装nvm,运行以下命令
```
curl -o- https://raw.githubusercontent.com/nvm-sh/nvm/master/install.sh | bash
```
### 3. 配置环境变量
在`~/.bashrc`文件中配置以下内容:
```
export NVM_DIR="$([ -z "${XDG_CONFIG_HOME-}" ] && printf %s "${HOME}/.nvm" || printf %s "${XDG_CONFIG_HOME}/nvm")"
[ -s "$NVM_DIR/nvm.sh" ] && \. "$NVM_DIR/nvm.sh" # This loads nvm
```
### 4. 验证nvm安装
若要验证安装,输入以下命令:`command -v nvm`;如果安装成功则返回nvm,如果收到"找不到命令"或无响应,关闭当前终端,重新打开,然后重试。
```
command -v nvm
```
### 5. 列出当前安装的Node版本
查看当前安装的版本号,输入以下命令:`nvm ls`
```
nvm ls
```
![nvm](./nvm.png)
### 6. 安装Node.js(LTS)版本
这里我选择安装当前稳定的LTS版本,安装输入以下命令:`install --lts`
```
nvm install --lts
```
### 7. 验证Node.js安装
查看当前安装的版本号,输入以下命令:`version`
```
node --version
```
Binary file not shown.

Before

Width:  |  Height:  |  Size: 41 KiB

@@ -1,7 +0,0 @@
{
"label": "Prisma",
"position": 5,
"link": {
"type": "generated-index"
}
}
@@ -1,85 +0,0 @@
---
sidebar_position: 1
---
# Next.js + Prisma + Docker构建全栈
通过使用Next.js、Prisma和Docker来构建一个全栈应用。
## 先决条件
1. 已安装Node.js 18+
2. Prisma Postgres数据库
3. Next.js项目
4. 已安装Docker
5. 确认已启动数据库
>**提示**
如果不知道怎么启动数据库,可以参考使用 [Docker启动数据库](/docs/tools/docker/start)文档
## 项目初始化
- 打开Next.js项目
### 1. 安装并初始化Prisma
我们需要安装Prisma客户端,运行以下代码
```
npm install prisma --save-dev
```
然后,项目初始化Prisma,运行以下命令:`init`
```
npx prisma init
```
这时会出现新目录,里面包含`schema.prisma`文件
### 2.定义表结构
#### 2.1 编辑`schema.prisma`文件
在`prisma/schema.prisma`文件中定义数据库表结构,添加以下内容:
```
model User {
id Int @id @default(autoincrement())
email String @unique
name String?
}
```
#### 2.2 配置`.env`文件
打开`.env`文件,配置PostgreSQL数据库连接字符串。例如
```
DATABASE_URL="postgresql://postgres:example@localhost:5432/postgres"
```
### 3. 数据库migration
配置完后,可以使用以下命令将架构应用到数据库中:`prisma migrate dev`
```
npx prisma migrate dev --name init
```
### 4. 使用Prisma Studio验证数据
#### 4.1 启动Prisma Studio
运行以下命令启动`Prisma Studio`:
```
npx prisma studio
```
#### 4.2 验证数据
在`Prisma Studio`中,可以查看`User`表的数据,通过添加、编辑或修改记录,验证表是否正确
![添加记录](./verify1.png)
![添加成功](./verify2.png)
### 5. 在Next.js中使用Prisma
#### 5.1 设置Prisma客户端
运行以下命令,创建一个新目录并在其添加一个新文件`lib/prisma.ts`
```
mkdir -p lib && touch lib/prisma.ts
```
在`lib/prisma.ts`文件中添加以下代码:
```
import { PrismaClient } from '@prisma/client'
const prisma = new PrismaClient()
const globalForPrisma = global as unknown as { prisma: typeof prisma }
if (process.env.NODE_ENV !== 'production') globalForPrisma.prisma = prisma
export default prisma
```
Binary file not shown.

Before

Width:  |  Height:  |  Size: 83 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 78 KiB

@@ -1,7 +0,0 @@
{
"label": "VSCode",
"position": 6,
"link": {
"type": "generated-index"
}
}
Binary file not shown.

Before

Width:  |  Height:  |  Size: 221 KiB

@@ -1,39 +0,0 @@
---
sidebar_position: 1
---
# 如何处理vscode安装插件异常
让我们通过以下步骤来解决插件安装失败
## 1. 检查网络是否异常
在浏览器中输入以下网址,看是否能访问,若能则不存在网络问题
```
https://marketplace.visualstudio.com
```
如果一切正常,您应该在`https://marketplace.visualstudio.com`有一个Extensions for Visual Studio Code的页面。
![vscode扩展页面](./marketplace.png)
## 2. 防火墙阻止
当我们第一次启动调试功能的时候,正常情况vscode会弹出防火墙阻止的界面
![防火墙](./code.png)
## 3. 设置代理
![设置图片](./setting.png)
![json图片](./json.png)
在`setting.json`中添加以下代理
```
"http.proxy": "http://127.0.0.1:7897",
"https.proxy": "http://127.0.0.1:7897",
"http.proxyAuthorization": null,
"http.proxyStrictSSL": false
```
## 4. clash配置
如果以上步骤都解决不了,需要查看以下`clash`的配置是否完成
## 5. 配置恢复
当需要安装的插件安装完成后,就可以上面的代理配置给注释了
Binary file not shown.

Before

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 189 KiB

Binary file not shown.

Before

Width:  |  Height:  |  Size: 32 KiB