docs: correct the link

Author: coder-hxl

docs/about/faq.md

@@ -6,7 +6,7 @@ The crawlPage API has built-in [puppeteer](https://github.com/puppeteer/puppetee
 
 ## Using crawlPage API causes the program to crash
 
-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).
+If you need to crawl many pages in one crawlPage, it is recommended that after crawling each page, use [onCrawlItemComplete life cycle function](/guide/crawl-page#life-cycle) 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'

docs/api/crawl-data.md

@@ -26,12 +26,12 @@ type crawlData = {
 
 **Parameter Type:**
 
-- View the [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig) type
-- View the [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig) type
+- View the [CrawlDataDetailTargetConfig](/type/crawl-data#crawldatadetailtargetconfig) type
+- View the [CrawlDataAdvancedConfig](/type/crawl-data#crawldataadvancedconfig) type
 
 **Return value type:**
 
-- View the [CrawlDataSingleResult](#CrawlDataSingleResult) type
+- View the [CrawlDataSingleResult](/type/crawl-data#crawldatasingleresult) type
 
 ## Example
 
@@ -77,7 +77,9 @@ const crawlApp = createCrawl()
 crawlApp.crawlData('https://www.example.com/api').then((res) => {})
 ```
 
+::: tip
 The res obtained will be an object.
+:::
 
 ### Detailed target configuration - CrawlDataDetailTargetConfig
 
@@ -97,9 +99,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an object.
+For more configuration options, see [CrawlDataDetailTargetConfig](type/crawl-data#crawldatadetailtargetconfig).
 
-For more configuration options, see [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
+::: tip
+The res obtained will be an object.
+:::
 
 ### Mixed target array configuration - (string | CrawlDataDetailTargetConfig)[]
 
@@ -118,9 +122,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlDataDetailTargetConfig](type/crawl-data#crawldatadetailtargetconfig).
 
-For more configuration options, see [CrawlDataDetailTargetConfig](#CrawlDataDetailTargetConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
 ### Advanced configuration - CrawlDataAdvancedConfig
 
@@ -144,8 +150,10 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlDataAdvancedConfig](/cn/type/crawl-data#crawldataadvancedconfig).
 
-For more configuration options, see [CrawlDataAdvancedConfig](#CrawlDataAdvancedConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
-For more information about the results, please view [About the results](#About the results). You can choose it according to the actual situation.
+For more information about the results, please view [About the results](/guide/results#about-the-results). You can choose it according to the actual situation.

docs/api/crawl-file.md

@@ -22,12 +22,12 @@ type crawlFile = {
 
 **Parameter Type:**
 
-- View the [CrawlFileDetailTargetConfig](#CrawlFileDetailTargetConfig) type
-- View the [CrawlFileAdvancedConfig](#CrawlFileAdvancedConfig) type
+- View the [CrawlFileDetailTargetConfig](/type/crawl-file#crawlfiledetailtargetconfig) type
+- View the [CrawlFileAdvancedConfig](/type/crawl-file#crawlfileadvancedconfig) type
 
 **Return value type:**
 
-- View the [CrawlFileSingleResult](#CrawlFileSingleResult) type
+- View the [CrawlFileSingleResult](/type/crawl-file#crawlfilesingleresult) type
 
 ## Example
 
@@ -74,7 +74,9 @@ const crawlApp = createCrawl()
 crawlApp.crawlFile('https://www.example.com/file').then((res) => {})
 ```
 
+::: tip
 The res obtained will be an object.
+:::
 
 ### Detailed target configuration - CrawlFileDetailTargetConfig
 
@@ -96,9 +98,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an object.
+For more configuration options, see [CrawlFileDetailTargetConfig](/type/crawl-file#crawlfiledetailtargetconfig).
 
-For more configuration options, see [CrawlFileDetailTargetConfig](#CrawlFileDetailTargetConfig).
+::: tip
+The res obtained will be an object.
+:::
 
 ### Mixed target array configuration - (string | CrawlFileDetailTargetConfig)[]
 
@@ -118,9 +122,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlFileDetailTargetConfig](/type/crawl-file#crawlfiledetailtargetconfig).
 
-For more configuration options, see [CrawlFileDetailTargetConfig](#CrawlFileDetailTargetConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
 ### Advanced configuration - CrawlFileAdvancedConfig
 
@@ -144,8 +150,10 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlFileAdvancedConfig](/type/crawl-file/cn/type/crawl-file#crawlfileadvancedconfig).
 
-For more configuration options, see [CrawlFileAdvancedConfig](#CrawlFileAdvancedConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
-For more information about the results, please view [About the results](#About the results). You can choose it according to the actual situation.
+For more information about the results, please view [About the results](/guide/results#about-the-results). You can choose it according to the actual situation.

docs/api/crawl-html.md

@@ -22,12 +22,12 @@ type crawlHTML = {
 
 **Parameter Type:**
 
-- View the [CrawlHTMLDetailTargetConfig](#CrawlHTMLDetailTargetConfig) type
-- View the [CrawlHTMLAdvancedConfig](#CrawlHTMLAdvancedConfig) type
+- View the [CrawlHTMLDetailTargetConfig](/type/crawl-html#crawlhtmldetailtargetconfig) type
+- View the [CrawlHTMLAdvancedConfig](/type/crawl-html#crawlhtmladvancedconfig) type
 
 **Return value type:**
 
-- View the [CrawlHTMLSingleResult](#CrawlHTMLSingleResult) type
+- View the [CrawlHTMLSingleResult](/type/crawl-html#crawlhtmlsingleresult) type
 
 ## Example
 
@@ -61,7 +61,9 @@ const crawlApp = createCrawl()
 crawlApp.crawlHTML('https://www.example.com').then((res) => {})
 ```
 
+::: tip
 The res obtained will be an object.
+:::
 
 ### Detailed target configuration - CrawlHTMLDetailTargetConfig
 
@@ -81,9 +83,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an object.
+For more configuration options, see [CrawlHTMLDetailTargetConfig](/type/crawl-html#crawlhtmldetailtargetconfig).
 
-For more configuration options, see [CrawlHTMLDetailTargetConfig](#CrawlHTMLDetailTargetConfig).
+::: tip
+The res obtained will be an object.
+:::
 
 ### Mixed target array configuration - (string | CrawlHTMLDetailTargetConfig)[]
 
@@ -102,9 +106,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlHTMLDetailTargetConfig](/type/crawl-html#crawlhtmldetailtargetconfig).
 
-For more configuration options, see [CrawlHTMLDetailTargetConfig](#CrawlHTMLDetailTargetConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
 ### Advanced configuration - CrawlHTMLAdvancedConfig
 
@@ -128,8 +134,10 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlHTMLAdvancedConfig](/type/crawl-html#crawlhtmladvancedconfig).
 
-For more configuration options, see [CrawlHTMLAdvancedConfig](#CrawlHTMLAdvancedConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
-For more information about the results, please view [About the results](#About the results). You can choose it according to the actual situation.
+For more information about the results, please view [About the results](/guide/results#about-the-results). You can choose it according to the actual situation.

docs/api/crawl-page.md

@@ -22,12 +22,12 @@ type crawlPage = {
 
 **Parameter Type:**
 
-- View the [CrawlPageDetailTargetConfig](#CrawlPageDetailTargetConfig) type
-- View the [CrawlPageAdvancedConfig](#CrawlPageAdvancedConfig) type
+- View the [CrawlPageDetailTargetConfig](/type/crawl-page#crawlpagedetailtargetconfig) type
+- View the [CrawlPageAdvancedConfig](/type/crawl-page#crawlpageadvancedconfig) type
 
 **Return value type:**
 
-- View the [CrawlPageSingleResult](#CrawlPageSingleResult) type
+- View the [CrawlPageSingleResult](/type/crawl-page#crawlpagesingleresult) type
 
 ## Example
 
@@ -66,7 +66,9 @@ const crawlApp = createCrawl()
 crawlApp.crawlPage('https://www.example.com').then((res) => {})
 ```
 
+::: tip
 The res obtained will be an object.
+:::
 
 ### Detailed target configuration - CrawlPageDetailTargetConfig
 
@@ -86,9 +88,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an object.
+For more configuration options, see [CrawlPageDetailTargetConfig](/type/crawl-page#crawlpagedetailtargetconfig).
 
-For more configuration options, see [CrawlPageDetailTargetConfig](#CrawlPageDetailTargetConfig).
+::: tip
+The res obtained will be an object.
+:::
 
 ### Mixed target array configuration - (string | CrawlPageDetailTargetConfig)[]
 
@@ -107,9 +111,11 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlPageDetailTargetConfig](/type/crawl-page#crawlpagedetailtargetconfig).
 
-For more configuration options, see [CrawlPageDetailTargetConfig](#CrawlPageDetailTargetConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
 ### Advanced configuration - CrawlPageAdvancedConfig
 
@@ -133,8 +139,10 @@ crawlApp
   .then((res) => {})
 ```
 
-The res obtained will be an array containing objects.
+For more configuration options, see [CrawlPageAdvancedConfig](/type/crawl-page#crawlpageadvancedconfig).
 
-For more configuration options, see [CrawlPageAdvancedConfig](#CrawlPageAdvancedConfig).
+::: tip
+The res obtained will be an array containing objects.
+:::
 
-For more information about the results, please view [About the results](#About the results). You can choose it according to the actual situation.
+For more information about the results, please view [About the results](/guide/results#about-the-results). You can choose it according to the actual situation.

docs/api/create-crawl-openai.md

@@ -12,11 +12,11 @@ function createXCrawlOpenAI(config?: CreateXCrawlOpenAIConfig): XCrawlOpenAIApp
 
 **Parameter Type:**
 
-- View the [CreateXCrawlOpenAIConfig](#CreateXCrawlOpenAIConfig) type
+- View the [CreateXCrawlOpenAIConfig](/type/create-crawl-openai#createcrawlopenaiconfig) type
 
 **Return value type:**
 
-- View the [XCrawlOpenAIApp](#XCrawlOpenAIApp) type
+- View the [XCrawlOpenAIApp](/type/create-crawl-openai#crawlopenaiapp) type
 
 ## Example
 

docs/api/get-element-selectors.md

@@ -16,12 +16,12 @@ function getElementSelectors(
 
 **Parameter Type:**
 
-- View the [XCrawlOpenAIGetElementSelectorsContentOptions](#XCrawlOpenAIGetElementSelectorsContentOptions) type
-- View the [XCrawlOpenAICommonAPIOtherOption](#XCrawlOpenAICommonAPIOtherOption) type
+- View the [XCrawlOpenAIGetElementSelectorsContentOptions](/type/get-element-selectors#crawlopenaigetelementselectorscontentoptions) type
+- View the [XCrawlOpenAICommonAPIOtherOption](/type/crawl-openai-other-config#crawlopenaicommonapiotheroption) type
 
 **Return value type:**
 
-- View the [XCrawlOpenAIGetElementSelectorsResult](#XCrawlOpenAIGetElementSelectorsResult) type
+- View the [XCrawlOpenAIGetElementSelectorsResult](/type/get-element-selectors#crawlopenaigetelementselectorsresult) type
 
 ## Example
 

docs/api/help.md

@@ -15,7 +15,7 @@ function help(
 
 **Parameter Type:**
 
-- View the [XCrawlOpenAICommonAPIOtherOption](#XCrawlOpenAICommonAPIOtherOption) type
+- View the [XCrawlOpenAICommonAPIOtherOption](/type/crawl-openai-other-config#crawlopenaicommonapiotheroption) type
 
 ## Example
 

docs/api/index.md

@@ -1,4 +1,4 @@
-#createCrawl
+# createCrawl
 
 Create a crawler application instance by calling createCrawl. The crawl target is maintained internally by the instance method, not by the instance.
 
@@ -12,11 +12,11 @@ function createCrawl(config?: CreateCrawlConfig): CrawlApp
 
 **Parameter Type:**
 
-- View the [CreateCrawlConfig](#CreateCrawlConfig) type
+- View the [CreateCrawlConfig](/type/index#createcrawlconfig) type
 
 **Return value type:**
 
-- View the [CrawlApp](#CrawlApp) type
+- View the [CrawlApp](/type/index#crawlapp) type
 
 ## Example
 

docs/api/parse-elements.md

@@ -16,12 +16,12 @@ function parseElements<T extends Record<string, string>>(
 
 **Parameter Type:**
 
-- View the [XCrawlOpenAIParseElementsContentOptions](#XCrawlOpenAIParseElementsContentOptions) type
-- View the [XCrawlOpenAICommonAPIOtherOption](#XCrawlOpenAICommonAPIOtherOption) type
+- View the [XCrawlOpenAIParseElementsContentOptions](/type/parse-elements#crawlopenaiparseelementscontentoptions) type
+- View the [XCrawlOpenAICommonAPIOtherOption](/type/crawl-openai-other-config#crawlopenaicommonapiotheroption) type
 
 **Return value type:**
 
-- View the [XCrawlOpenAIParseElementsResult](#XCrawlOpenAIParseElementsResult) type
+- View the [XCrawlOpenAIParseElementsResult](/type/parse-elements#crawlopenaiparseelementsresult) type
 
 ## Example