From c4d8bfe0acf417ca73aa7291a7b9c9e337c189cd Mon Sep 17 00:00:00 2001
From: KBLonay <i@lonay.me>
Date: Thu, 15 Aug 2024 23:42:55 +0800
Subject: [PATCH] docs: update api and puppeteer plugin config (#49)

Co-authored-by: Shigma <shigma10826@gmail.com>
---
 docs/api.md               | 18 ++++++++++++++----
 docs/plugins/puppeteer.md | 37 ++++++++++++++++++++++++++++++++-----
 2 files changed, 46 insertions(+), 9 deletions(-)

diff --git a/docs/api.md b/docs/api.md
index ae6acce..9e84634 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -4,24 +4,34 @@
 
 可以通过 `ctx.puppeteer` 访问。
 
-### puppeteer.launch()
+### browser
 
-- 返回值: `Promise<void>`
+- 类型: `Browser`
 
-启动并连接浏览器。
+浏览器实例。
 
-### puppeteer.close()
+### puppeteer.stop()
 
 - 返回值: `Promise<void>`
 
 关闭浏览器并取消连接。
 
+::: tip
+在使用远程浏览器时，关闭浏览器不会关闭远程浏览器进程。
+:::
+
 ### puppeteer.page()
 
 - 返回值: `Promise<Page>`
 
 创建一个新页面。
 
+### puppeteer.svg(options?)
+
+- 返回值: `SVG`
+
+创建一个 SVG 实例。
+
 ### puppeteer.render(content, callback?)
 
 - **content:** `string` 要渲染的 HTML
diff --git a/docs/plugins/puppeteer.md b/docs/plugins/puppeteer.md
index 6b2f3d5..9e7230a 100644
--- a/docs/plugins/puppeteer.md
+++ b/docs/plugins/puppeteer.md
@@ -4,7 +4,32 @@
 
 ## 配置项
 
-### executablePath
+### 连接配置
+
+#### remote
+
+- 类型：`boolean`
+
+是否使用远程浏览器。
+
+#### endpoint
+
+- 类型：`string`
+
+远程浏览器的地址。
+
+::: tip
+支持 HTTP 或 WebSocket 协议。请在启动浏览器时指定 `--remote-debugging-port` 参数以开启远程调试和确定其端口。
+
+- HTTP 协议：`http(s)://{host}:{port}`
+- WebSocket 协议：`ws(s)://{host}:{port}/devtools/browser/{id}`
+:::
+
+#### headers
+
+- 类型：`Record<string, string>`
+
+#### executablePath
 
 - 类型：`string`
 
@@ -14,20 +39,22 @@
 目前仅支持 Chrome 和 Edge 的寻找。Firefox 用户请手动配置此项或者欢迎 pull request。
 :::
 
-### headless
+#### headless
 
 - 类型：`boolean`
 - 默认值：`true`
 
 是否开启[无头模式](https://developer.chrome.com/blog/headless-chrome/)。
 
-### args
+#### args
 
 - 类型：`string[]`
 
 额外的浏览器参数。Chromium 参数可以参考[这个页面](https://peter.sh/experiments/chromium-command-line-switches/)。
 
-### defaultViewport
+### 浏览器配置
+
+#### defaultViewport
 
 默认的设备缩放比率。有以下属性：
 
@@ -35,7 +62,7 @@
 - height: `number` 视图高度，默认为 600
 - deviceScaleFactor: `number` 设备缩放比率，默认为 2
 
-### ignoreHTTPSErrors
+#### ignoreHTTPSErrors
 
 - 类型：`boolean`
 - 默认值：`false`