Skip to content

Commit a11dcd8

Browse files
committed
✨ add docs for advanced searching
1 parent 14ae792 commit a11dcd8

File tree

5 files changed

+86
-8
lines changed

5 files changed

+86
-8
lines changed
Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
---
2+
sidebar_position: 5
3+
description: 高级搜索
4+
5+
options:
6+
menu:
7+
weight: 50
8+
category: guide
9+
---
10+
11+
# 高级搜索
12+
13+
NB-CLI 提供了一套高级搜索的支持,便于用户检索商店内容。
14+
15+
:::tip 注意
16+
此功能仅在交互式 CLI(如 `nb plugin install` 等)和 TUI(如插件/适配器/驱动浏览界面)中可用,普通命令行参数不支持此功能。
17+
:::
18+
19+
## 功能简介
20+
21+
高级搜索允许你通过关键词、排除词、过滤器等方式,精准筛选项目。
22+
23+
### 关键词搜索
24+
25+
直接输入关键词,模糊匹配名称、描述、项目链接等字段。
26+
27+
### 排除关键词
28+
29+
使用 `-关键词` 排除包含该关键词的结果。
30+
示例:
31+
32+
```
33+
-ai -llm
34+
```
35+
36+
### 高级过滤器
37+
38+
可用 `#` 前缀指定过滤器:
39+
40+
- `#official`:仅显示官方项目
41+
- `#passing`:仅显示通过校验的插件
42+
- `#tag:标签名`:按标签筛选(逗号分隔多个标签)
43+
- `#author:作者名`:按作者筛选(逗号分隔多个作者)
44+
45+
示例:
46+
47+
```
48+
#official #tag:工具,管理
49+
```
50+
51+
### 排除过滤器(! 前缀)
52+
53+
`!` 前缀排除某类过滤器结果,与 `-` 前缀不同:
54+
55+
- `!official`:排除官方项目
56+
- `!tag:xxx`:排除指定标签
57+
- `!author:xxx`:排除指定作者
58+
59+
示例:
60+
61+
```
62+
!official !tag:娱乐
63+
```
64+
65+
### 组合用法
66+
67+
可将关键词、`-` 前缀、`#`/`!` 前缀、带参数 filter 混合使用,支持分号分隔多组条件:
68+
69+
```
70+
工具 -测试 #official !tag:娱乐; 管理 #tag:管理
71+
```
72+
73+
### 交互行为说明
74+
75+
- `-关键词`:排除包含该关键词的所有项目
76+
- `!filter`:排除 filter 作用范围内的项目
77+
- `#filter`:仅保留 filter 作用范围内的项目
78+
- `tag:``author:` 可用逗号分隔多个值

website/docs/guide/plugin.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 7
2+
sidebar_position: 8
33
description: CLI 插件配置
44

55
options:
66
menu:
7-
weight: 70
7+
weight: 80
88
category: guide
99
---
1010

website/docs/guide/script.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 6
2+
sidebar_position: 7
33
description: 项目脚本配置
44

55
options:
66
menu:
7-
weight: 60
7+
weight: 70
88
category: guide
99
---
1010

website/docs/guide/self-management.mdx

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 5
2+
sidebar_position: 6
33
description: CLI 自身管理
44

55
options:
66
menu:
7-
weight: 50
7+
weight: 60
88
category: guide
99
---
1010

website/docs/guide/shell-completion.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,10 @@
11
---
2-
sidebar_position: 8
2+
sidebar_position: 9
33
description: Shell 自动补全
44

55
options:
66
menu:
7-
weight: 80
7+
weight: 90
88
category: guide
99
---
1010

0 commit comments

Comments
 (0)