Skip to content

Commit 4a2bf3f

Browse files
committed
docs: 修复文档编译错误
1 parent a31f60b commit 4a2bf3f

File tree

4 files changed

+18
-19
lines changed

4 files changed

+18
-19
lines changed

README.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
<div align="center">
88

9-
[![Version](https://img.shields.io/badge/version-v0.2.1-blue.svg)](https://github.com/xerrors/Yuxi-Know/issues)
9+
[![Version](https://img.shields.io/badge/version-v0.2.2-blue.svg)](https://github.com/xerrors/Yuxi-Know/issues)
1010
[![](https://img.shields.io/badge/Docker-2496ED?style=flat&logo=docker&logoColor=ffffff)](https://github.com/xerrors/Yuxi-Know/blob/main/docker-compose.yml)
1111
[![](https://img.shields.io/github/issues/xerrors/Yuxi-Know?color=F48D73)](https://github.com/xerrors/Yuxi-Know/issues)
1212
[![License](https://img.shields.io/github/license/bitcookies/winrar-keygen.svg?logo=github)](https://github.com/xerrors/Yuxi-Know/blob/main/LICENSE)
@@ -52,10 +52,10 @@
5252
### 一键启动
5353

5454
1. **克隆项目**
55-
```bash
56-
git clone -b 0.2.1 https://github.com/xerrors/Yuxi-Know.git
57-
cd Yuxi-Know
58-
```
55+
```bash
56+
git clone --branch 0.2.2 --depth 1 https://github.com/xerrors/Yuxi-Know.git
57+
cd Yuxi-Know
58+
```
5959
如果想要使用之前的稳定版(与现版本不兼容),可以使用 `stable` 分支,`main` 分支是最新的开发版本。
6060

6161
2. **配置 API 密钥**

docs/advanced/misc.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
| **8081** | vLLM | - | 本地推理(可选)|
2323

2424
::: tip 端口访问
25-
- Web 界面: http://localhost:5173
26-
- API 文档: http://localhost:5050/docs
27-
- Neo4j 管理: http://localhost:7474
25+
- Web 界面: `http://localhost:5173`
26+
- API 文档: `http://localhost:5050/docs`
27+
- Neo4j 管理: `http://localhost:7474`
2828
:::

docs/intro/knowledge-base.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
| **Milvus** | 高性能向量数据库 | 大规模生产环境、高性能查询 |
1313
| **LightRAG** | 图增强检索 | 复杂知识关系,构建成本较高 |
1414

15-
访问 Web 界面:http://localhost:5173,进入"知识库管理"页面,点击"新建知识库",填写知识库信息。
15+
访问 Web 界面:`http://localhost:5173`,进入"知识库管理"页面,点击"新建知识库",填写知识库信息。
1616

1717
这里需要**注意**的是,这里的知识库的标题和描述都会作为智能体选择工具的依据,因此尽量详尽的描述该知识库。
1818

@@ -60,7 +60,7 @@ Neo4j 访问信息可以参考 `docker-compose.yml` 中配置对应的环境变
6060

6161
- **默认账户**: `neo4j`
6262
- **默认密码**: `0123456789`
63-
- **管理界面**: http://localhost:7474
63+
- **管理界面**: `http://localhost:7474`
6464
- **连接地址**: bolt://localhost:7687
6565

6666
::: tip 测试数据
@@ -80,4 +80,4 @@ Neo4j 访问信息可以参考 `docker-compose.yml` 中配置对应的环境变
8080

8181
::: warning 注意事项
8282
确保每个节点都有 `Entity` 标签,每个关系都有 `RELATION` 类型,否则会影响图的检索与构建功能。
83-
:::
83+
:::

docs/intro/quick-start.md

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@
1414

1515
```bash
1616
# 克隆稳定版本
17-
git clone -b 0.2.1 https://github.com/xerrors/Yuxi-Know.git
17+
git clone --branch 0.2.2 --depth 1 https://github.com/xerrors/Yuxi-Know.git
1818
cd Yuxi-Know
1919
```
2020

2121
::: warning 版本说明
22-
- `0.2.1`: 当前稳定版本(推荐)
22+
- `0.2.2`: 当前稳定版本(推荐)
2323
- `stable`: 旧版本稳定分支(与现版本不兼容)
2424
- `main`: 最新开发版本(可能不稳定)
2525
:::
@@ -57,8 +57,8 @@ docker compose up --build -d
5757

5858
服务启动完成后,访问以下地址:
5959

60-
- **Web 界面**: http://localhost:5173
61-
- **API 文档**: http://localhost:5050/docs
60+
- **Web 界面**: `http://localhost:5173`
61+
- **API 文档**: `http://localhost:5050/docs`
6262

6363
#### 5. 停止服务
6464

@@ -162,8 +162,8 @@ docker ps
162162
**Q: MinerU/PaddleX 健康检查失败?**
163163

164164
分别检查服务状态:
165-
- MinerU: http://localhost:30000/health
166-
- PaddleX: http://localhost:8080/
165+
- MinerU: `http://localhost:30000/health`
166+
- PaddleX: `http://localhost:8080/`
167167

168168
确认 GPU/驱动与 CUDA 版本匹配。
169169

@@ -182,5 +182,4 @@ docker restart api-dev
182182
检查默认账户信息:
183183
- 用户名: `neo4j`
184184
- 密码: `0123456789`
185-
- 管理界面: http://localhost:7474
186-
185+
- 管理界面: `http://localhost:7474`

0 commit comments

Comments
 (0)