some doc

dromara · Dec 29, 2023 · 0b45d23 · 0b45d23
1 parent e0a4735
commit 0b45d23
Show file tree

Hide file tree

Showing 21 changed files with 73 additions and 62 deletions.
diff --git a/docs/.vuepress/config.ts b/docs/.vuepress/config.ts
@@ -1,14 +1,14 @@
-import {getDirname, path} from "@vuepress/utils";
-import {defineUserConfig} from "vuepress";
-import {docsearchPlugin} from "@vuepress/plugin-docsearch";
+import { getDirname, path } from "@vuepress/utils";
+import { defineUserConfig } from "vuepress";
+import { docsearchPlugin } from "@vuepress/plugin-docsearch";
 import theme from "./theme.js";
 
 const __dirname = getDirname(import.meta.url);
 
 export default defineUserConfig({
   title: "Fast Request",
   description: "Intellij Restful Fast Request",
-  shouldPrefetch:false,
+  shouldPrefetch: false,
   head: [
     [
       "link",
@@ -17,9 +17,12 @@ export default defineUserConfig({
         href: "/img/fastRequest.svg",
       },
     ],
-    ["script", { src: "//at.alicdn.com/t/c/font_2601581_144d8yxi3ht.js","async":true }],
+    [
+      "script",
+      { src: "//at.alicdn.com/t/c/font_2601581_144d8yxi3ht.js", async: true },
+    ],
     // ["script", { src: "/js/baidu.js" ,"async":true}],
-    ["script", { src: "/js/gtag.js" ,"async":true}],
+    ["script", { src: "/js/gtag.js", async: true }],
     [
       "script",
       {},
@@ -32,13 +35,15 @@ export default defineUserConfig({
         `,
     ],
     [
-    'script', {}, `
+      "script",
+      {},
+      `
       window.dataLayer = window.dataLayer || [];
       function gtag(){dataLayer.push(arguments);}
       gtag('js', new Date());
       gtag('config', 'G-Y8G30ZWCYE');
-    `
-    ]
+    `,
+    ],
     // ["script", { src: "https://cdn.wwads.cn/js/makemoney.js" }],
   ],
 
@@ -90,7 +95,7 @@ export default defineUserConfig({
   alias: {
     "@theme-hope/layouts/Layout": path.resolve(
       __dirname,
-      "./layouts/Layout.vue"
+      "./layouts/Layout.vue",
     ),
     // "@theme-hope/components/HomePage": path.resolve(
     //     __dirname,

diff --git a/docs/.vuepress/public/html/showside.html b/docs/.vuepress/public/html/showside.html
@@ -75,7 +75,7 @@
     border-radius: 3px;
   }
 </style>
-<body style="margin: 0; background: #0C1117">
+<body style="margin: 0; background: #0c1117">
   <div class="image-gallery">
     <div class="image-gallery__image"></div>
     <div class="image-gallery__list">

diff --git a/docs/.vuepress/public/html/showside_en.html b/docs/.vuepress/public/html/showside_en.html
@@ -75,7 +75,7 @@
     border-radius: 8px;
   }
 </style>
-<body style="margin: 0; background: #0C1117">
+<body style="margin: 0; background: #0c1117">
   <div class="image-gallery">
     <div class="image-gallery__image"></div>
     <div class="image-gallery__list">

diff --git a/docs/.vuepress/public/img/2023.2.4/ignoreFiled.png b/docs/.vuepress/public/img/2023.2.4/ignoreFiled.png
diff --git a/docs/.vuepress/public/img/2023.2.4/ignoreFiled_en.png b/docs/.vuepress/public/img/2023.2.4/ignoreFiled_en.png
diff --git a/docs/.vuepress/public/img/2023.2.4/searchEveryWhere.png b/docs/.vuepress/public/img/2023.2.4/searchEveryWhere.png
diff --git a/docs/.vuepress/public/img/2023.2.4/searchEveryWhere_en.png b/docs/.vuepress/public/img/2023.2.4/searchEveryWhere_en.png
diff --git a/docs/.vuepress/styles/config.scss b/docs/.vuepress/styles/config.scss
@@ -1 +1 @@
-$theme-colors: #21d789,#f26d6d, #07c3f2, #fc801d, #087cfa, #fe2857;
+$theme-colors: #21d789, #f26d6d, #07c3f2, #fc801d, #087cfa, #fe2857;
diff --git a/docs/.vuepress/styles/index.scss b/docs/.vuepress/styles/index.scss
@@ -34,16 +34,16 @@ h2 {
     "BEVL" 100;
 }
 
-.vp-hero-action.primary:hover{
-    background-color: #303033;
-    color: #fff;
+.vp-hero-action.primary:hover {
+  background-color: #303033;
+  color: #fff;
 }
-.vp-hero-action.primary{
-    font-family: alimamaYuanMainTitle, sans-serif;
-    margin-top: 30px;
-    border-color: #0B1117;
-    background-color: #0B1117;
-    color: #fff;
+.vp-hero-action.primary {
+  font-family: alimamaYuanMainTitle, sans-serif;
+  margin-top: 30px;
+  border-color: #0b1117;
+  background-color: #0b1117;
+  color: #fff;
 }
 .svg-icon {
   width: 1em;

diff --git a/docs/.vuepress/styles/palette.scss b/docs/.vuepress/styles/palette.scss
@@ -1,4 +1,4 @@
-$theme-color: #51A8FC;
+$theme-color: #51a8fc;
 
 $text-color: (
   light: #2c3e50,
@@ -7,7 +7,7 @@ $text-color: (
 
 $bg-color: (
   light: #fff,
-  dark: #0C1117,
+  dark: #0c1117,
 );
 
 $bg-color-secondary: (

diff --git a/docs/.vuepress/theme.ts b/docs/.vuepress/theme.ts
@@ -1,7 +1,7 @@
-import {getDirname, path} from "@vuepress/utils";
-import {hopeTheme} from "vuepress-theme-hope";
-import {enNavbar, zhNavbar} from "./navbar.js";
-import {enSidebar, zhSidebar} from "./sidebar.js";
+import { getDirname, path } from "@vuepress/utils";
+import { hopeTheme } from "vuepress-theme-hope";
+import { enNavbar, zhNavbar } from "./navbar.js";
+import { enSidebar, zhSidebar } from "./sidebar.js";
 
 const __dirname = getDirname(import.meta.url);
 
@@ -50,7 +50,7 @@ export default hopeTheme(
       },
 
       components: {
-        components: ["Badge", "BiliBili", "SiteInfo","VPCard"],
+        components: ["Badge", "BiliBili", "SiteInfo", "VPCard"],
         rootComponents: {
           addThis: "ra-617a48e0d1826cc4",
           notice: [
@@ -108,5 +108,5 @@ export default hopeTheme(
       },
     },
   },
-  { custom: true }
+  { custom: true },
 );
diff --git a/docs/README.md b/docs/README.md
@@ -102,7 +102,6 @@ head:
 
 设计师森阳`[email protected]` logo设计
 
-
 <!-- @include: @src/contact.snippet.md -->
 
 [plugin]: https://plugins.jetbrains.com/plugin/16988

diff --git a/docs/en/README.md b/docs/en/README.md
@@ -46,11 +46,10 @@ head:
 [![Slack](https://img.shields.io/static/v1?label=Slack&message=Restful%20Fast%20Request&logo=slack&color=38B580)](https://join.slack.com/t/restfulfastrequest/shared_invite/zt-1we57vum8-TALhTHI2uNmPF2bx1NDyWw)
 [![twitter](https://img.shields.io/static/v1?label=Twitter&message=FastRequest666&logo=twitter&color=FC8D34)](https://twitter.com/FastRequest666)
 [![](https://badgen.net/badge/Github/fast-request/21D789?icon=github)](https://github.com/dromara/fast-request)
- [![Jetbrains Plugins][plugin-img]][plugin] ![Version](https://img.shields.io/jetbrains/plugin/v/16988?logo=IntelliJ%20IDEA) ![Downloads](https://img.shields.io/jetbrains/plugin/d/16988?color=FE2857)
+[![Jetbrains Plugins][plugin-img]][plugin] ![Version](https://img.shields.io/jetbrains/plugin/v/16988?logo=IntelliJ%20IDEA) ![Downloads](https://img.shields.io/jetbrains/plugin/d/16988?color=FE2857)
 
 <div style="margin-top: 20px;"></div>
 
-
 ## Advantage
 
 <div class="home-advantage">
@@ -75,7 +74,6 @@ head:
 
 <!-- @include: @src/en/compare.snippet.md -->
 
-
 <!-- @include: @src/en/contact.snippet.md -->
 
 [plugin]: https://plugins.jetbrains.com/plugin/16988

diff --git a/docs/en/guide/faq.md b/docs/en/guide/faq.md
@@ -16,7 +16,7 @@ icon: faq
 
 You need to manually turn on the notification message. If notification messages are not turned on, many messages cannot be displayed, so IDEA's message notification settings need to be configured. Other situations are handled similarly.
 
-Go to `Setting-> Appearance & Behavior->Nofications` , check `Display ballon notifications` and `Enable system notifications`. If  Fast Request is checked in `Don't ask again nofications`, this item needs to be removed.
+Go to `Setting-> Appearance & Behavior->Nofications` , check `Display ballon notifications` and `Enable system notifications`. If Fast Request is checked in `Don't ask again nofications`, this item needs to be removed.
 
 ![enableNotifications](/img/faq/enableNotifications.png)
 
@@ -165,6 +165,7 @@ Click **help->Edit Custom Vm Options...**,add the following config in **idea.vmo
 ```
 -Dsun.net.http.allowRestrictedHeaders=true
 ```
+
 ## Q: Response return Unexpected end of file from server
 
 ```
@@ -176,7 +177,6 @@ Click **help->Edit Custom Vm Options...**,add the following config in **idea.vmo
 
 How to set IDEA proxy: `Setting-> Appearance & Behavior->System Settings->HTTP Proxy`
 
-
 ## Q: Action buttons are not visible
 
 Click `Options` and check `Show Toolbar`

diff --git a/docs/en/guide/features/postmanSync.md b/docs/en/guide/features/postmanSync.md
@@ -3,15 +3,14 @@
 Version required: <Badge text="2023.2.3" />
 
 ::: tip
-To  make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
+To make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
 then trigger the synchronization by saving the API.
 
 It is also recommended to use this function to synchronize the API instead of exporting
 :::
 
 ![postmanSync](/img/2023.2.3/postmanSync_en.png)
 
-
 ## Api key
 
 API key is used to perform manual actions using the Postman Online API. These actions include **creating collections**, **creating directories**, **creating requests**, and more.

diff --git a/docs/en/guide/history.md b/docs/en/guide/history.md
@@ -20,9 +20,9 @@ Join and follow us to solve your question ❤️❤️❤️↓↓↓
 
 ---
 
-important: <Badge text="Important function" color="orange"/> 
+important: <Badge text="Important function" color="orange"/>
 
-feat: <Badge text="New function" type="tip"/>  perf: <Badge text="Optimization function" type="info"/> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span> fix: <Badge text="Fix or Remove function" type="danger"/>
+feat: <Badge text="New function" type="tip"/> perf: <Badge text="Optimization function" type="info"/> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span> fix: <Badge text="Fix or Remove function" type="danger"/>
 
 Because developing version is still in development, the documentation of developing version may not be entirely accurate and is subject to change.
 :::
@@ -33,28 +33,31 @@ and some plug-in versions are rendering components under specific systems (such
 :::
 
 ## 2023.2.4 <Badge text="Free trial" type="tip"/> <Badge text="Developing" color="pink"/>
+
 - <Badge text="SearchEveryWhere support classname search" color="orange"/>
 - <Badge text="Do not generate .fastRequest directory if plugin not used" color="orange"/>
 - <Badge text="Ignore field name parse support" type="tip"/>
-- <Badge text="SearchEveryWhere performance optimization" type="info"/>  
+- <Badge text="SearchEveryWhere performance optimization" type="info"/>
 - <Badge text="Content-Disposition support optimization" type="info"/>
 
-
 ::: tip SearchEveryWhere support classname search
-Support enter the class name where the Url is located to search for all APIs under this class
+Support enters the class name where the Url is located to search for all APIs under this class.
+
+![searchEveryWhere](/img/2023.2.4/searchEveryWhere_en.png)
 :::
 
-::: tip Do not generate .fastRequest directory if plugin not used
+::: tip Do not generate .fastRequest directory if plugin is not used.
 When Project is opened by default, the .fastRequest directory will no longer be generated. Only the operation plugin will generate it.
 :::
 
 ::: tip Ignore field name parse support
 Only need to add field names in the configuration to ignore target fields in the entity class.
 
+![ignoreFiled](/img/2023.2.4/ignoreFiled_en.png)
 :::
 
 ::: info SearchEveryWhere performance optimization
-The SearchEveryWhere search logic has been optimized to greatly improve the search performance of large projects. 
+The SearchEveryWhere search logic has been optimized to greatly improve the search performance of large projects.
 
 We tested a project with 7000 APIs and the search response was very fast
 :::
@@ -71,12 +74,13 @@ Content-Disposition:attachment; filename=fastRequest.txt
 :::
 
 ## 2023.2.3.1 <Badge text="Free trial" type="tip"/> <Badge text="Newest version" />
+
 - <Badge text="JSON5 support error" type="danger"/>
 
 ## 2023.2.3 <Badge text="Free trial" type="tip"/>
 
 - <Badge text="Sync API to Postman" type="tip"/>
-- <Badge text="Project name drop-down box automatically switches" type="tip"/>  
+- <Badge text="Project name drop-down box automatically switches" type="tip"/>
 - <Badge text="Environment refactoring" type="info"/>
 - <Badge text="Project domain name addition optimization" type="info"/>
 - <Badge text="Change API document sync trigger to API is saved" type="info"/>
@@ -88,7 +92,7 @@ Content-Disposition:attachment; filename=fastRequest.txt
 ::: tip Sync API to Postman
 You only need to configure the token of Postman and the ID of the workspace to upload the API to Postman.Enjoy what fast request do not support.
 
-To  make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
+To make the data synchronised to Postman more complete, it is recommended to select the `sync after API save` option in the Postman config of the plugin
 then trigger the synchronisation by saving the API.
 
 More details please refer [Postman sync](./features/postmanSync.md)

diff --git a/docs/en/guide/whatsnew.md b/docs/en/guide/whatsnew.md
@@ -20,7 +20,7 @@ Join and follow us to solve your question ❤️❤️❤️↓↓↓
 
 ---
 
-important: <Badge text="Important function" color="orange"/> 
+important: <Badge text="Important function" color="orange"/>
 
 feat: <Badge text="New function" type="tip"/> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span> perf: <Badge text="Optimization function" type="info"/> <span>&nbsp;&nbsp;&nbsp;&nbsp;</span> fix: <Badge text="Fix or Remove function" type="danger"/>
 
@@ -30,19 +30,21 @@ Because developing version is still in development, the documentation of develop
 [**More detail ---------------->**](./history.md)
 
 ## 2023.2.4 <Badge text="Free trial" type="tip"/> <Badge text="Developing" color="pink"/>
+
 - <Badge text="SearchEveryWhere support classname search" color="orange"/>
 - <Badge text="Do not generate .fastRequest directory if plugin not used" color="orange"/>
 - <Badge text="Ignore field name parse support" type="tip"/>
-- <Badge text="SearchEveryWhere performance optimization" type="info"/>  
+- <Badge text="SearchEveryWhere performance optimization" type="info"/>
 - <Badge text="Content-Disposition support optimization" type="info"/>
 
 ## 2023.2.3.1 <Badge text="Free trial" type="tip"/> <Badge text="Newest version" />
+
 - <Badge text="JSON5 support error" type="danger"/>
 
 ## 2023.2.3 <Badge text="Free trial" type="tip"/> <Badge text="Newest version" />
 
 - <Badge text="Sync API to Postman" type="tip"/>
-- <Badge text="Project name drop-down box automatically switches" type="tip"/>  
+- <Badge text="Project name drop-down box automatically switches" type="tip"/>
 - <Badge text="Environment refactoring" type="info"/>
 - <Badge text="Project domain name addition optimization" type="info"/>
 - <Badge text="Change API document sync trigger to API is saved" type="info"/>
@@ -51,7 +53,7 @@ Because developing version is still in development, the documentation of develop
 - <Badge text="Error when passing non-json in body param" type="danger"/>
 - <Badge text="curl import parsing\' error" type="danger"/>
 
-## 2023.2.2 <Badge text="Free trial" type="tip"/> 
+## 2023.2.2 <Badge text="Free trial" type="tip"/>
 
 - <Badge text="Markdown doc template config" type="tip"/>
 - <Badge text="JSON5 support" type="tip"/>

diff --git a/docs/guide/activity.md b/docs/guide/activity.md
@@ -2,11 +2,12 @@
 title: 活动
 icon: activity
 ---
+
 ## 20231205
 
 B站粉丝突破**1000**，我决定抽个奖,感谢开发者的支持。==关注+点赞+留言==下方视频，进行抽奖，赠送1年license，已购买的开发者可以延长插件license到期时间1年
 
-官网: [https://api-buddy.cn/guide/activity.html#_20231205](https://api-buddy.cn/guide/activity.html#_20231205)
+官网: [https://api-buddy.cn/guide/activity.html#\_20231205](https://api-buddy.cn/guide/activity.html#_20231205)
 
 抽奖程序：[https://injectrl.github.io/BiliCLOnline/](https://api-buddy.cn/guide/activity.html)
 

diff --git a/docs/guide/features/postmanSync.md b/docs/guide/features/postmanSync.md
@@ -11,7 +11,6 @@
 
 ![postmanSync](/img/2023.2.3/postmanSync.png)
 
-
 ## Api key
 
 Api key 用于使用 Postman 在线 API 执行一些手工行为.例如**创建Collection**、**创建目录**、**创建 Request** 等行为.
Original file line number	Diff line number	Diff line change
		@@ -1 +1 @@
		$theme-colors: #21d789,#f26d6d, #07c3f2, #fc801d, #087cfa, #fe2857;
		$theme-colors: #21d789, #f26d6d, #07c3f2, #fc801d, #087cfa, #fe2857;
Original file line number	Diff line number	Diff line change
Expand Up		@@ -102,7 +102,6 @@ head:

		设计师森阳`[email protected]` logo设计


		<!-- @include: @src/contact.snippet.md -->

		[plugin]: https://plugins.jetbrains.com/plugin/16988
Expand Down
Original file line number	Diff line number	Diff line change
Expand Up		@@ -11,7 +11,6 @@

		![postmanSync](/img/2023.2.3/postmanSync.png)


		## Api key

		Api key 用于使用 Postman 在线 API 执行一些手工行为.例如创建Collection、创建目录、创建 Request 等行为.
Expand Down