V0.0.1.4 pw1文档更新

docs/.vitepress/config.mts

@@ -6,7 +6,7 @@ const require = createRequire(import.meta.url)
 
 const pkg = require('vitepress/package.json')
 
-const version = "v0.0.1.3-pw.1"
+const version = "v0.0.1.4-pw.1"
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({

docs/cli.md

@@ -0,0 +1,106 @@
+# 命令行
+
+`F2` 配置文件独立于 CLI 命令参数且`最低优先`。
+
+## CLI临时配置
+
+CLI 参数命令优先级最高，所以在不修改配置文件的情况下就可以使用 CLI 参数更改为下载「抖音」用户`喜欢`的所有作品。因此也可以在 CLI 中临时下载A的直播，B的作品与C的喜欢。
+
+::: code-group
+
+```bash [用户A]
+$ f2 -d dy -c C:\Users\JohnserfSeed\Desktop\A.yaml -M live -u https://live.douyin.com/xxxxxxxxx
+```
+
+```bash [用户B]
+$ f2 -d dy -c C:\Users\JohnserfSeed\Desktop\B.yaml -M post
+```
+
+```bash [用户C]
+$ f2 -d dy -c C:\Users\JohnserfSeed\Desktop\C.yaml -M like
+```
+:::
+
+赶快试试吧！
+
+::: tip 说明
+之后的版本会简化操作。不需要再指定该用户的直播间就可以切换下载该用户直播的模式。
+更多的 CLI 命令请查阅 [CLI 参考](/cli)。
+:::
+
+::: warning 重要
+- 命名方式也不受限制，你可以设置`dy-A.yaml`、`dy-B.yaml`、`tk-A.yaml`、`tk-B.ymal`用以区分不同app的用户配置。
+- 配置的操作是通用的，举例用的是douyin的配置文件，tiktok与其他 F2 应用的配置文件的操作是一模一样的。
+:::
+
+
+## 拓展
+
+如果不想设置很多配置文件，那就使用主配置。
+
+下载「抖音」用户`发布`的所有作品，只需要在主配置文件中设置`mode: post`即可。
+
+::: code-group
+
+```sh [Windows]
+$ f2 dy -c f2/conf/app.yaml
+```
+
+```sh [Linux]
+$ f2 dy -c f2/conf/app.yaml
+```
+
+```sh [MacOS]
+$ f2 dy -c f2/conf/app.yaml
+```
+:::
+
+下载「抖音」用户`喜欢`的所有作品，CLI 中设置`mode: like`即可。
+
+::: code-group
+
+```sh [Windows]
+$ f2 dy -M like -c f2/conf/app.yaml
+```
+
+```sh [Linux]
+$ f2 dy -M like -c f2/conf/app.yaml
+```
+
+```sh [MacOS]
+$ f2 dy -M like -c f2/conf/app.yaml
+```
+:::
+
+下载「抖音」用户`单个`的作品:
+
+::: code-group
+
+```sh [Windows]
+$ f2 dy -M one -u https://v.douyin.com/iRNBho6u/ -c conf/app.yaml
+```
+
+```sh [Linux]
+$ f2 dy -M one -u https://v.douyin.com/iRNBho6u/ -c conf/app.yaml
+```
+
+```sh [MacOS]
+$ f2 dy -M one -u https://v.douyin.com/iRNBho6u/ -c conf/app.yaml
+```
+:::
+
+F2 会智能的识别出混乱文本中的链接，同时也支持长短链的输入。
+
+::: details 支持的链接格式
+
+<<< @/snippets/douyin/support-link.md
+:::
+
+::: tip 需要注意的是
+在CLI模式下，带有其他信息的文本需要用英文引号将其完整包裹:
+
+```sh [Windows]
+$ f2 dy -M one -u '7.64 gOX:/ w@f.oD 05/14 世界这本书 又多读了一页。冰岛????旅行记# 冰岛  https://v.douyin.com/iR2syBRn/ 复制此链接，打开Dou音搜索，直接观看视！
+' -c conf/app.yaml
+```
+:::

docs/guide/what-is-f2.md

@@ -7,23 +7,18 @@
 开发者可以直接定义自己的配置文件，然后在测试时通过`-c`参数指定配置文件的路径，例如：
 
 ```bash
-f2 -d dy -c conf/app.yaml
+f2 -d DEBUG dy -c app.yaml
 ```
 也可以在代码中指定配置文件的路径，例如：
 
-```python
-import f2
-
-f2.APP_CONFIG_FILE_PATH = "conf/app.yaml"
-```
+<<< @/snippets/set-debug.py#set-config-snippet{3}
 
 ## 调试日志级别
 
 <<< @/snippets/set-debug.py#set-debug-snippet{5}
 
 ![set-debug](/douyin/set-debug.png)
 
-
 ## 日志输出到控制台
 
 <<< @/snippets/set-debug.py#log-2-console-snippet{5}
@@ -32,4 +27,4 @@ f2.APP_CONFIG_FILE_PATH = "conf/app.yaml"
 
 ::: tip 提示
 如果你想要输出到控制台的日志更加详细，可以使用 `DEBUG` 级别。并且后续必须使用该logger对象来输出日志，否则日志将不会输出到控制台。
-:::
+:::

docs/install.md

@@ -6,32 +6,38 @@
 - [Windows Terminal](https://aka.ms/terminal) 终端，通过命令行界面（CLI）访问。
 - 支持[Python](https://en.wikipedia.org/wiki/python) 语法的文本编辑器。
   - 推荐使用[VSCode](https://code.visualstudio.com/) 或[VSCode在线](https://vscode.dev)。
+- [Git](https://git-scm.com/) ，用于开发者从GitHub上克隆项目。
 
-`F2` 可单独使用，也可安装到现有项目中。在这两种情况下，你都可以使用以下命令选择不同版本安装:
+## 包管理器安装
+
+`F2` 可单独使用，也可安装到现有项目中。在这两种情况下，你都可以使用以下命令选择不同版本安装：
 
 ::: code-group
 
 ```sh [Windows]
-$ pip install f2              # 最新版本
-$ pip install f2==x.x.x       # 指定版本
-$ pip install 'f2>=x.x.x'     # 最小版本
+$ pip install f2                # 最新版本
+$ pip install f2==x.x.x.x       # 指定版本
+$ pip install -U f2             # 更新版本
+$ pip uninstall f2              # 卸载版本
 ```
 
 ```sh [Linux]
-$ pip3 install f2              # 最新版本
-$ pip3 install f2==x.x.x       # 指定版本
-$ pip3 install 'f2>=x.x.x'     # 最小版本
+$ pip3 install f2                # 最新版本
+$ pip3 install f2==x.x.x.x       # 指定版本
+$ pip3 install -U f2             # 更新版本
+$ pip3 uninstall f2              # 卸载版本
 ```
 
 ```sh [MacOS]
-$ pip3 install f2              # 最新版本
-$ pip3 install f2==x.x.x       # 指定版本
-$ pip3 install 'f2>=x.x.x'     # 最小版本
+$ pip3 install f2                # 最新版本
+$ pip3 install f2==x.x.x.x       # 指定版本
+$ pip3 install -U f2             # 更新版本
+$ pip3 uninstall f2              # 卸载版本
 ```
 :::
 
 ::: details 收到依赖或其他警告?
-如果提示python或pip版本错误，请尝试更新到必备条件的版本。
+如果提示python或pip版本错误，请务必更新到必备条件的版本。
 
 如果你的网络环境缓慢，无法正常访问官方镜像。请使用可以正常访问的第三方镜像源。
 ::: code-group
@@ -49,6 +55,31 @@ $ pip3 install -i https://pypi.tuna.tsinghua.edu.cn/simple f2
 ```
 :::
 
+## 编译安装
+
+如果你是开发者需要修改代码编译安装项目，可以使用以下命令：
+
+::: code-group
+
+```sh [Windows]
+$ git clone https://github.com/Johnserf-Seed/f2.git
+$ cd f2
+$ pip install -e .  #注意点前面有一个空格
+```
+
+```sh [Linux]
+$ git clone https://github.com/Johnserf-Seed/f2.git
+$ cd f2
+$ pip3 install -e . #注意点前面有一个空格
+```
+
+```sh [MacOS]
+$ git clone https://github.com/Johnserf-Seed/f2.git
+$ cd f2
+$ pip3 install -e . #注意点前面有一个空格
+```
+:::
+
 ::: tip 提示
 
 `F2` 是一个异步库，开发者在调用方法前请仔细`阅读相关文档`。

docs/question-answer/qa.md

@@ -14,4 +14,8 @@
 
 ## f2: command not found
 
-<<< @/snippets/QA.md#f2-command-not-found
+<<< @/snippets/QA.md#f2-command-not-found
+
+## WARNING  没有找到符合条件的作品
+
+<<< @/snippets/QA.md#no-matching-videos-found

docs/quick-start.md

@@ -7,7 +7,7 @@
 
 ## 启动和运行
 
-`F2` 设计的初衷是方便用户与开发者一键采集多平台的`异步`库。支持 CLI 命令调用与接口调用。
+`F2` 是一个灵活的`异步`下载库。`F2` 设计的初衷是方便用户与开发者一键采集多平台的`异步`库。支持 CLI 命令调用与接口调用。
 
 ![cli-start](/f2-help.png)