📝 add alconna wildcard arg description

Author: RF-Tar-Railt

.vitepress/config/index.mts

@@ -19,7 +19,7 @@ export default defineConfig({
     nav: nav,
     sidebar: sidebar,
     editLink: {
-      pattern: 'https://github.com/ArcletProject/Documents/edit/refactor/:path',
+      pattern: 'https://github.com/ArcletProject/Documents/edit/main/:path',
       text: '在 GitHub 编辑此页'
     },
     socialLinks: [
@@ -41,6 +41,9 @@ export default defineConfig({
       prev: '上一页',
       next: '下一页'
     },
+    search: {
+      provider: 'local',
+    },
     darkModeSwitchLabel: '黑暗模式',
     lightModeSwitchTitle: '切换到浅色模式',
     darkModeSwitchTitle: '切换到黑暗模式',
@@ -60,5 +63,8 @@ export default defineConfig({
     config: (md) => {
       md.use(fence);
     }
+  },
+  rewrites: {
+    '/docs/:path': '/:path',
   }
 })

tutorial/alconna/index.md

@@ -0,0 +1,8 @@
+<script setup>
+import { onMounted } from 'vue';
+onMounted(() => {
+  if (typeof window !== 'undefined') {
+    window.location.replace('/tutorial/alconna/v1');
+  }
+})
+</script>

tutorial/alconna/v1.md

@@ -189,20 +189,91 @@ args = Args["foo", BasePattern("@\d+")]
 
 #### MultiVar 与 KeyWordVar
 
-`MultiVar` 是一个特殊的标注，用于告知解析器该参数可以接受多个值，类似于函数中的 `*args`，其构造方法形如 `MultiVar(str)`。
+`MultiVar` 是一个特殊的标注，用于告知解析器该参数可以接受多个值，类似于函数中的 `*args`，其构造方法形如 `MultiVar(str)`。其返回值为一个元组，包含了所有匹配到的值。
 
 同样的还有 `KeyWordVar`，类似于函数中的 `*, name: type`，其构造方法形如 `KeyWordVar(str)`，用于告知解析器该参数为一个 keyword-only 参数。
 
-:::info
-
-`MultiVar` 与 `KeyWordVar` 组合时，代表该参数为一个可接受多个 key-value 的参数，类似于函数中的 `**kwargs`，其构造方法形如 `MultiVar(KeyWordVar(str))`
+`MultiVar` 与 `KeyWordVar` 组合时，代表该参数为一个可接受多个 key-value 的参数，类似于函数中的 `**kwargs`，其构造方法形如 `MultiVar(KeyWordVar(str))`。其返回值为一个字典，包含了所有匹配到的键值对。
 
 `MultiVar` 与 `KeyWordVar` 也可以传入 `default` 参数，用于指定默认值
 
 `MultiVar` 不能在 `KeyWordVar` 之后传入
 
+:::code-group
+
+```python [MultiVar]
+from arclet.alconna import Alconna, Args, MultiVar
+
+alc = Alconna("test", Args["foo", MultiVar(str)])
+
+res = alc.parse("test 123 456 789")
+print(res.query("foo"))  # ('123', '456', '789')
+```
+
+```python [MultiVar(KeyWordVar)]
+from arclet.alconna import Alconna, Args, MultiVar, KeyWordVar
+
+alc = Alconna("test", Args["foo", MultiVar(KeyWordVar(str))])
+
+res = alc.parse("test 123=456 789=abc")
+print(res.query("foo"))  # {'123': '456', '789': 'abc'}
+```
+
+:::
+
+#### StrMulti
+
+`StrMulti` 是一个特殊的 `BasePattern`。
+
+其基于 `MultiVar(str)`, 用于匹配多个字符串参数，并返回拼接后的字符串。
+
+```python
+from arclet.alconna import Alconna, Args, StrMulti
+
+alc = Alconna("test", Args["foo", StrMulti])
+
+res = alc.parse("test 123 456 789")
+print(res.query("foo"))  # '123 456 789'
+```
+
+#### 泛匹配
+
+`Args` 通过设置 `var` 为 `AllParam` 来实现泛匹配。
+
+`AllParam` 是一个特殊的 `BasePattern`，从 `arclet.alconna.typing` 中导入。
+
+当命令解析进行到 `AllParam` 时，传入命令的**后续所有数据都会被匹配到该参数上**。
+
+:::code-group
+
+```python [直接使用]
+from arclet.alconna import Alconna, Args, AllParam
+
+alc = Alconna("test", Args["foo", AllParam])
+
+res = alc.parse("test 123 456 789")
+print(res.query("foo"))  # ['123', '456', '789']
+```
+
+```python [配置类型]
+from arclet.alconna import Alconna, Args, AllParam
+
+alc = Alconna("test", Args["foo", AllParam(str)])
+
+res = alc.parse(["test", "123", "456", 789])
+print(res.query("foo"))  # ['123', '456']
+```
+:::
+
+可以注意到，`AllParam` 的返回值是一个列表，包含了所有匹配到的值。
+
+:::info
+
+返回值的类型与 `Argv.converter` 有关，默认处理为列表。而在其他场景继承并修改了 `Argv` 的情况下，返回值可能会有所不同。
+
 :::
 
+
 ### 参数单元(Arg)
 
 **Arg** 是 **Args** 的最小单位：

tutorial/alconna/v2.md

@@ -252,6 +252,39 @@ args = Args.foo(Pattern.regex_match("@\d+"))
 - `"str"`: 表示接受多个值，但会被合并为一个字符串
 :::
 
+
+`wildcard` 的值为 `True` 时，表示该参数为泛匹配参数。当命令解析进行到该参数时，传入命令的**后续所有数据都会被匹配到该参数上**。
+
+:::code-group
+
+```python [任意匹配]
+from typing import Any
+from arclet.alconna import Alconna, Args
+
+alc = Alconna("test", Args.foo(Any, wildcard=True))
+
+res = alc.parse("test 123 456 789")
+print(res.query("foo"))  # ['123', '456', '789']
+```
+
+```python [类型匹配]
+from arclet.alconna import Alconna, Args
+
+alc = Alconna("test", Args.foo(str, wildcard=True))
+
+res = alc.parse(["test", "123", "456", 789])
+print(res.query("foo"))  # ['123', '456']
+```
+:::
+
+可以注意到，泛匹配的返回值是一个列表，包含了所有匹配到的值。
+
+:::info
+
+返回值的类型与 `Argv.converter` 有关，默认处理为列表。而在其他场景继承并修改了 `Argv` 的情况下，返回值可能会有所不同。
+
+:::
+
 ## 选项与子命令(Option & Subcommand)
 
 **Option** 与 **Subcommand** 是 Alconna 中的两个重要组件。

tutorial/nepattern/index.md

@@ -0,0 +1,8 @@
+<script setup>
+import { onMounted } from 'vue';
+onMounted(() => {
+  if (typeof window !== 'undefined') {
+    window.location.replace('/tutorial/nepattern/v0');
+  }
+})
+</script>