feat(docs): root is an English document

Author: coder-hxl

docs/.vitepress/config.ts

@@ -3,16 +3,25 @@
  * -------------------------------------------------------------------------- */
 
 :root {
-  --c-yellow-theme: #feba07;
-  --c-red-theme: #7c1823;
+  --c-yellow-theme: #feba07;  /* yellow */
+  --c-golden-yellow-theme: #f26b1f;  /* golden yellow */
+}
+
+/*
+ * Colors: Function
+ * -------------------------------------------------------------------------- */
+
+:root {
+  --vp-c-brand-1: var(--c-yellow-theme);
+  --vp-c-brand-2: var(--c-golden-yellow-theme);
 }
 
 /**
  * Component: Button
  * -------------------------------------------------------------------------- */
 :root {
   --vp-button-brand-bg: var(--c-yellow-theme);
-  --vp-button-brand-hover-bg:#e4a507;
+  --vp-button-brand-hover-bg:var(--c-golden-yellow-theme);
 }
 
 /**
@@ -21,7 +30,7 @@
 
 :root {
   --vp-home-hero-name-color: transparent;
-  --vp-home-hero-name-background: linear-gradient(290deg, var(--c-red-theme) 6%, var(--c-yellow-theme));
-  --vp-home-hero-image-background-image: linear-gradient(180deg, var(--c-yellow-theme) 60%, var(--c-red-theme) 30%);
-  --vp-home-hero-image-filter: blur(40px);
+  --vp-home-hero-name-background: linear-gradient(108deg, var(--c-yellow-theme) 30%,  var(--c-golden-yellow-theme));
+  --vp-home-hero-image-background-image: linear-gradient(var(--c-yellow-theme), var(--c-golden-yellow-theme), var(--c-yellow-theme));
+  --vp-home-hero-image-filter: blur(68px);
 }

docs/.vitepress/theme/style/vars.css

@@ -1,5 +1,5 @@
-# 注意事项
+# Precautions
 
-- x-crawl 仅供合法用途，禁止使用该工具进行任何违法活动，包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等行为。
-- 在进行数据采集之前，请确保您已经获得了目标网站的明确授权，并遵守其 robots.txt 文件规定以及使用条款。
-- 避免对目标网站造成过大的访问压力，以免触发其反爬策略或造成服务器宕机。
+- x-crawl is for legal purposes only. It is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, network attacks, privacy violations, etc.
+- Before collecting data, make sure you have explicit authorization from the target website and comply with its robots.txt file and terms of use.
+- Avoid placing excessive access pressure on the target website to avoid triggering its anti-crawling strategy or causing server downtime.

docs/about/announcements.md

@@ -1,6 +1,6 @@
-# 社区
+# Community
 
-- **Discord 聊天:** 通过 [Discord](https://discord.gg/SF7aaebg4E) 与其他 x-crawl 用户实时提问和讨论（提前了解关于 x-crawl 的动态）。
-- **GitHub 讨论:** 使用 [GitHub 讨论](https://github.com/coder-hxl/x-crawl/discussions) 来进行留言板式的问题和讨论。
+- **Discord Chat:** Ask and discuss with other x-crawl users in real time via [Discord](https://discord.gg/SF7aaebg4E) (keep up to date on x-crawl news in advance).
+- **GitHub Discussions:** Use [GitHub Discussions](https://github.com/coder-hxl/x-crawl/discussions) for message board-style questions and discussions.
 
-不得提交与任何非法活动相关的问题和讨论。x-crawl 仅供合法用途，禁止使用该工具进行任何违法活动，包括但不限于未经授权的数据采集、网络攻击、隐私侵犯等行为。请确保您的使用行为始终符合法律法规和道德标准，共同维护一个安全、合法的网络环境。
+Questions and discussions related to any illegal activity may not be submitted. x-crawl is for legal purposes only, and it is prohibited to use this tool to conduct any illegal activities, including but not limited to unauthorized data collection, network attacks, privacy violations, etc. Please ensure that your usage behavior always complies with laws, regulations and ethical standards, and jointly maintain a safe and legal network environment.

docs/about/community.md

@@ -1,53 +1,53 @@
-# 常见问题
+# common problem
 
-## crawlPage API 跟 puppeteer 的关系
+## The relationship between crawlPage API and puppeteer
 
-crawlPage API 内置了 [puppeteer](https://github.com/puppeteer/puppeteer) ，您只需要传入一些配置选项即可让 x-crawl 帮助您简化操作，并拿到完好无损的 Brower 实例和 Page 实例，x-crawl 并不会对其重写。
+The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppeteer). You only need to pass in some configuration options to let x-crawl help you simplify the operation and get intact Brower instances and Pages. instance, x-crawl does not override it.
 
-## 使用 crawlPage API 造成程序崩溃
+## Using crawlPage API causes the program to crash
 
-如果你需要在一个 crawlPage 爬取很多页面，建议在每个页面爬下来后，用 [onCrawlItemComplete 生命周期函数](#onCrawlItemComplete) 来处理每个目标的结果并关闭 page 实例，如果不进行关闭操作，则可能因开启的 page 过多而造成程序崩溃（跟自身设备性能有关）。
+If you need to crawl many pages in one crawlPage, it is recommended that after crawling each page, use [onCrawlItemComplete life cycle function] (#onCrawlItemComplete) to process the results of each target and close the page instance. If no shutdown operation is performed, then The program may crash due to too many pages being opened (related to the performance of the device itself).
 
 ```js{11,12,13,14,15,16,,17,,18,35,36,37,38,39,40}
 import { createCrawl } from 'x-crawl'
 
 const crawlApp = createCrawl()
 
-// 爬取目标少的推荐
+// Recommendations with few crawling targets
 crawlApp
-  .crawlPage([
-    'https://www.example.com/page-1',
-    'https://www.example.com/page-2'
-  ])
-  .then((results) => {
-    for (const itemResult of results) {
-      const { page } = itemResult.data
-
-      // 后续不再使用就关闭
-      page.close()
-    }
-  })
-
-// 爬取目标多的推荐
-// 通过进阶配置的 onCrawlItemComplete
+   .crawlPage([
+     'https://www.example.com/page-1',
+     'https://www.example.com/page-2'
+   ])
+   .then((results) => {
+     for (const itemResult of results) {
+       const { page } = itemResult.data
+
+       //Close if no longer used
+       page.close()
+     }
+   })
+
+// Crawling recommendations with many targets
+//onCrawlItemComplete through advanced configuration
 crawlApp.crawlPage({
-  targets: [
-    'https://www.example.com/page-1',
-    'https://www.example.com/page-2',
-    'https://www.example.com/page-3',
-    'https://www.example.com/page-4',
-    'https://www.example.com/page-5',
-    'https://www.example.com/page-6',
-    'https://www.example.com/page-7',
-    'https://www.example.com/page-8',
-    'https://www.example.com/page-9',
-    'https://www.example.com/page-10'
-  ],
-  onCrawlItemComplete(crawlPageSingleResult) {
-    const { page } = crawlPageSingleResult.data
-
-    // 后续不再使用就关闭
-    page.close()
-  }
+   targets: [
+     'https://www.example.com/page-1',
+     'https://www.example.com/page-2',
+     'https://www.example.com/page-3',
+     'https://www.example.com/page-4',
+     'https://www.example.com/page-5',
+     'https://www.example.com/page-6',
+     'https://www.example.com/page-7',
+     'https://www.example.com/page-8',
+     'https://www.example.com/page-9',
+     'https://www.example.com/page-10'
+   ],
+   onCrawlItemComplete(crawlPageSingleResult) {
+     const { page } = crawlPageSingleResult.data
+
+     //Close if no longer used
+     page.close()
+   }
 })
 ```

docs/about/faq.md

@@ -1,3 +1,3 @@
-# Issues
+#Issues
 
-如果您有 **问题 、需求、好的建议** 可以在 [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues) 中提 **Issues** 。
+If you have **questions, requirements, and good suggestions**, you can raise **Issues** in [GitHub Issues](https://github.com/coder-hxl/x-crawl/issues).

docs/about/issues.md

@@ -1,3 +1,3 @@
-# 旧版本文档
+# Old version documentation
 
-v9.0.0 版本：https://github.com/coder-hxl/x-crawl/blob/v9.0.0/docs/cn.md
+v9.0.0 version: https://github.com/coder-hxl/x-crawl/blob/v9.0.0/docs/cn.md

docs/about/old-docs.md

@@ -1,3 +1,3 @@
-# 版本发布
+# Version release
 
-完整的过往发布记录可以在 [GitHub](https://github.com/coder-hxl/x-crawl/blob/main/CHANGELOG.md) 查阅。
+The complete past release record can be viewed at [GitHub](https://github.com/coder-hxl/x-crawl/blob/main/CHANGELOG.md).

docs/about/releases.md

@@ -1,10 +1,10 @@
 # crawlData
 
-crawl 是爬虫实例的方法，通常用于爬取 API ，可获取 JSON 数据等等。
+crawl is a method of crawler instance, usually used to crawl API, obtain JSON data, etc.
 
-## 类型
+## type
 
-crawlData API 是一个函数。类型是 [重载函数](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads) 可以通过不同的配置参数调用该函数（在类型方面）。
+crawlData API is a function. A type is an [overloaded function](https://www.typescriptlang.org/docs/handbook/2/functions.html#function-overloads) that can be called with different configuration parameters (in terms of type).
 
 ```ts
 type crawlData = {
@@ -24,16 +24,16 @@ type crawlData = {
 }
 ```
 
-**参数类型：**
+**Parameter Type:**
 
-- 查看 [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig) 类型
-- 查看 [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig) 类型
+- View the [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig) type
+- View the [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig) type
 
-**返回值类型：**
+**Return value type:**
 
-- 查看 [CrawlDataSingleResult](#CrawlDataSingleResult) 类型
+- View the [CrawlDataSingleResult](#CrawlDataSingleResult) type
 
-## 示例
+## Example
 
 ```js
 import { createCrawl } from 'x-crawl'
@@ -56,18 +56,18 @@ crawlApp
   })
 ```
 
-## 配置
+## Configuration
 
-一共有 4 种:
+There are 4 types in total:
 
-- 简单目标配置 - string
-- 详细目标配置 - CrawlDataDetailTargetConfig
-- 混合目标数组配置 - (string | CrawlDataDetailTargetConfig)[]
-- 进阶配置 - CrawlDataAdvancedConfig
+- Simple target configuration - string
+- Detailed target configuration - CrawlDataDetailTargetConfig
+- Mixed target array configuration - (string | CrawlDataDetailTargetConfig)[]
+- Advanced configuration - CrawlDataAdvancedConfig
 
-### 简单目标配置 - string
+### Simple target configuration - string
 
-这是简单目标配置。如果你只想单纯爬一下这个数据，并且该接口是 GET 方式的，可以试试这种写法：
+This is a simple target configuration. If you just want to simply crawl this data, and the interface is GET, you can try this way of writing:
 
 ```js
 import { createCrawl } from 'x-crawl'
@@ -77,11 +77,11 @@ const crawlApp = createCrawl()
 crawlApp.crawlData('https://www.example.com/api').then((res) => {})
 ```
 
-拿到的 res 将是一个对象。
+The res obtained will be an object.
 
-### 详细目标配置 - CrawlDataDetailTargetConfig
+### Detailed target configuration - CrawlDataDetailTargetConfig
 
-这是详细目标配置。如果你想爬一下这个数据，并且需要失败重试之类的，可以试试这种写法：
+This is the detailed target configuration. If you want to crawl this data and need to retry after failure, you can try this way of writing:
 
 ```js
 import { createCrawl } from 'x-crawl'
@@ -97,13 +97,13 @@ crawlApp
   .then((res) => {})
 ```
 
-拿到的 res 将是一个对象。
+The res obtained will be an object.
 
-更多配置选项可以查看 [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig) 。
+For more configuration options, see [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
 
-### 混合目标数组配置 - (string | CrawlDataDetailTargetConfig)[]
+### Mixed target array configuration - (string | CrawlDataDetailTargetConfig)[]
 
-这是混合目标数组配置。如果你想爬取多个数据，并且有些数据需要失败重试之类的，可以试试这种写法：
+This is a mixed target array configuration. If you want to crawl multiple data, and some data needs to be failed and retried, you can try this way of writing:
 
 ```js
 import { createCrawl } from 'x-crawl'
@@ -118,13 +118,13 @@ crawlApp
   .then((res) => {})
 ```
 
-拿到的 res 将是一个数组，里面是对象。
+The res obtained will be an array containing objects.
 
-更多配置选项可以查看 [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig) 。
+For more configuration options, see [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
 
-### 进阶配置 - CrawlDataAdvancedConfig
+### Advanced configuration - CrawlDataAdvancedConfig
 
-这是进阶配置，targets 是混合目标数组配置。如果你想爬取多个数据，并且爬取目标配置（proxy、cookies、重试等等）不想重复写，还需要间隔时间、设备指纹以及生命周期等等，可以试试这种写法：
+This is an advanced configuration, targets is a mixed target array configuration. If you want to crawl multiple data, and you don’t want to write the crawling target configuration (proxy, cookies, retry, etc.) repeatedly, and you also need interval time, device fingerprint, life cycle, etc., you can try this way of writing:
 
 ```js
 import { createCrawl } from 'x-crawl'
@@ -144,8 +144,8 @@ crawlApp
   .then((res) => {})
 ```
 
-拿到的 res 将是一个数组，里面是对象。
+The res obtained will be an array containing objects.
 
-更多配置选项可以查看 [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig) 。
+For more configuration options, see [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig).
 
-关于结果的更多信息可查看 [关于结果](#关于结果) ，可以根据实际情况选用即可。
+For more information about the results, please view [About the results](#About the results). You can choose it according to the actual situation.