更新文档中的链接，修正资源路径和函数定义格式

pzq123456 · Jan 1, 2025 · 3f198ea · 3f198ea
1 parent e727f6f
commit 3f198ea
Show file tree

Hide file tree

Showing 238 changed files with 3,800 additions and 3,060 deletions.
diff --git a/README.md b/README.md
diff --git a/docs/.vitepress/config.ts b/docs/.vitepress/config.ts
@@ -1,4 +1,5 @@
-import { defineConfig } from 'vitepress'
+import { defineConfig } from 'vitepress';
+import typedocSidebar from "../api/typedoc-sidebar.json";
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
@@ -11,16 +12,15 @@ export default defineConfig({
     nav: [
       { text: 'Home', link: '/' },
       { text: 'Docs', link: '/documents' },
-      { text: 'API', link: '/api/globals' }
+      { text: 'API', link: '/api' }
     ],
 
     sidebar: [
+
+      { text: 'Docs', link: '/documents' },
       {
-        text: 'Examples',
-        items: [
-          { text: 'Docs', link: '/documents' },
-          { text: 'API', link: '/api/globals' }
-        ]
+        text: 'API',
+        items: typedocSidebar,
       }
     ],
 
@@ -33,5 +33,8 @@ export default defineConfig({
     footer: {
       copyright: `Released under the MIT License. Copyright © 2022-present <a href="https://github.com/pzq123456"> pzq123456 </a> `
     },
+  },
+  markdown: {
+    math: true
   }
 })
diff --git a/docs/.vitepress/theme/custom.css b/docs/.vitepress/theme/custom.css
@@ -10,7 +10,7 @@
   :root {
     --vp-home-hero-name-color: transparent;
     --vp-home-hero-name-background: -webkit-linear-gradient(120deg, #7a27c3 30%, #19aedf); /* 更新为新主题色 */
-    --vp-home-hero-image-background-image: linear-gradient(-45deg,rgba(108, 11, 219, 0.41) 50%,rgba(166, 204, 235, 0.54) 50%); /* 更新为新主题色 */
+    --vp-home-hero-image-background-image: linear-gradient(-45deg,rgba(108, 11, 219, 0.41) 50%,rgba(51, 91, 239, 0.54) 50%); /* 更新为新主题色 */
     --vp-home-hero-image-filter: blur(50px);
   }
 

diff --git a/docs/api/README.md b/docs/api/README.md
diff --git a/docs/api/classes/Circle.md b/docs/api/classes/Circle.md
@@ -1,22 +1,23 @@
-[**rvgeo**](../README.md)
+[rvgeo](../index.md) / Circle
 
-***
-
-[rvgeo](../globals.md) / Circle
-
-# Class: Circle
+# Circle
 
-Defined in: src/geometry/Circle.ts:5
+Defined in: [src/geometry/Circle.ts:5](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L5)
 
 平面图形：圆形
 
 ## Constructors
 
 ### new Circle()
 
-> **new Circle**(`x`, `y`, `r`): [`Circle`](Circle.md)
+```ts
+new Circle(
+   x, 
+   y, 
+   r): Circle
+```
 
-Defined in: src/geometry/Circle.ts:17
+Defined in: [src/geometry/Circle.ts:17](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L17)
 
 构造函数
 
@@ -48,41 +49,51 @@ Defined in: src/geometry/Circle.ts:17
 
 ### r
 
-> **r**: `number`
+```ts
+r: number;
+```
 
-Defined in: src/geometry/Circle.ts:8
+Defined in: [src/geometry/Circle.ts:8](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L8)
 
 ***
 
 ### rSquared
 
-> **rSquared**: `number`
+```ts
+rSquared: number;
+```
 
-Defined in: src/geometry/Circle.ts:9
+Defined in: [src/geometry/Circle.ts:9](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L9)
 
 ***
 
 ### x
 
-> **x**: `number`
+```ts
+x: number;
+```
 
-Defined in: src/geometry/Circle.ts:6
+Defined in: [src/geometry/Circle.ts:6](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L6)
 
 ***
 
 ### y
 
-> **y**: `number`
+```ts
+y: number;
+```
 
-Defined in: src/geometry/Circle.ts:7
+Defined in: [src/geometry/Circle.ts:7](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L7)
 
 ## Methods
 
 ### contains()
 
-> **contains**(`point`, `threshold`): `boolean`
+```ts
+contains(point, threshold): boolean
+```
 
-Defined in: src/geometry/Circle.ts:30
+Defined in: [src/geometry/Circle.ts:30](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L30)
 
 判断点是否在圆内
 
@@ -110,9 +121,11 @@ Defined in: src/geometry/Circle.ts:30
 
 ### intersects()
 
-> **intersects**(`range`): `boolean`
+```ts
+intersects(range): boolean
+```
 
-Defined in: src/geometry/Circle.ts:42
+Defined in: [src/geometry/Circle.ts:42](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L42)
 
 （仅平面下保证有效）判断圆是否与 MBR 相交
 
@@ -134,9 +147,11 @@ MBR
 
 ### isCircle()
 
-> `static` **isCircle**(`obj`): `obj is Circle`
+```ts
+static isCircle(obj): obj is Circle
+```
 
-Defined in: src/geometry/Circle.ts:69
+Defined in: [src/geometry/Circle.ts:69](https://github.com/pzq123456/RVGeo/blob/e727f6f6e310621d656b74948bed9956ff45a613/src/geometry/Circle.ts#L69)
 
 #### Parameters