update doc

Author: frankie-zeng

.github/workflows/pages.yml

@@ -28,6 +28,8 @@ jobs:
         run: npm install
       - name: Build with VitePress
         run: npm run docs:build
+      - name: Build with Typedoc
+        run: npm run api
       - name: Upload artifact
         env:
           ALIYUN_ACCESS_KEY_ID: ${{ secrets.ALIYUN_ACCESS_KEY_ID }}

.vitepress/config.mts

@@ -14,10 +14,15 @@ function nav(): DefaultTheme.NavItem[] {
         },
 
       ]
+    },
+    {
+      text: 'Script API',
+      link: 'https://app.whyengineer.com/scriptApi/index.html'
     }
   ]
 }
 // https://vitepress.dev/reference/site-config
+
 export default defineConfig({
   title: "EcuBus-Pro",
   ignoreDeadLinks: true,
@@ -72,8 +77,8 @@ export default defineConfig({
           { text: 'Graph', link: '/docs/um/graph/graph.md' },
           { text: 'CLI', link: '/docs/um/cli' },
           {
-            text: 'Script', link: '/docs/um/script', items: [
-              { text: 'Use External Package', link: '/docs/um/scriptSerialPort' },
+            text: 'Script', link: '/docs/um/script', items: [   
+              { text: 'Use External Package', link: '/docs/um/scriptExternal' },
             ]
           },
           {

README.md

@@ -43,7 +43,7 @@ For detailed information, please refer to our [User Manual](./docs/um/concept.md
 | PEAK | CAN, CAN-FD, LIN |
 | KVASER | CAN, CAN-FD |
 | ZLG | CAN, CAN-FD |
-| Toomoss | CAN, CAN-FD (Coming Soon) |
+| Toomoss | CAN, CAN-FD |
 
 #### Software Capabilities
 

package-lock.json

@@ -129,7 +129,7 @@
     "rollup-plugin-dts": "^6.1.1",
     "sass": "^1.83.0",
     "ts-loader": "^9.5.1",
-    "typedoc": "^0.26.11",
+    "typedoc": "^0.27.6",
     "typescript": "^5.3.3",
     "viewerjs": "^1.11.6",
     "vite": "^5.4.14",

package.json

@@ -36,6 +36,8 @@ async function put(list) {
   if(list.includes('--page')){
     const dist = path.join(__dirname, '..', '.vitepress','dist')
     await putDir(dist,'app/dist')
+    const api = path.join(__dirname, '..', 'resources', 'docs','scriptApi')
+    await putDir(api,'app/scriptApi')
   }
 
 

tools/upload.js

@@ -6,4 +6,19 @@
     "name":"EcuBus-Pro Script API Documentation",
     "readme": "docs/um/script.md",
     "skipErrorChecking": true,
+   
+   "navigationLinks": {
+        "Home": "https://app.whyengineer.com",
+        "GitHub": "https://github.com/ecubus/EcuBus-Pro",
+    },
+    "favicon": "./resources/icon.png",
+    "navigation": {
+        "includeCategories": true,
+       
+
+
+    },
+  
+    
+    
 }