generate sidebar

Author: vasfvitor

.gitignore

@@ -19,5 +19,5 @@ pnpm-debug.log*
 
 # macOS-specific files
 .DS_Store
-/public/api-reference
-packages/js-api-generator/build.js
+packages/js-api-generator/build.js
+/public/reference/javascript

astro.config.mjs

@@ -13,6 +13,7 @@ import path from 'path';
 import { fileURLToPath } from 'url';
 import lunaria from '@lunariajs/starlight';
 import { readFileSync } from 'fs';
+import referenceJavascriptSidebar from './src/_generated-javascript-reference-sidebar.js';
 
 const authors = {
   nothingismagick: {
@@ -178,6 +179,7 @@ export default defineConfig({
                     'develop/sidecar',
                     'develop/state-management',
                     'develop/updating-dependencies',
+                    'develop/icons',
                     {
                       label: 'Debug',
                       collapsed: true,
@@ -290,9 +292,9 @@ export default defineConfig({
                   autogenerate: { directory: 'release' },
                 },
                 {
-                  label: 'JavaScript',
-                  collapsed: true,
-                  autogenerate: { directory: 'reference/javascript' },
+                  label: 'JavaScript (TypeDoc)',
+                  // generated by js-api-generator
+                  items: referenceJavascriptSidebar,
                 },
                 {
                   label: 'Rust (docs.rs)',

packages/js-api-generator/build.ts

@@ -6,7 +6,9 @@ import { fileURLToPath } from 'node:url';
 const __filename = fileURLToPath(import.meta.url);
 const __dirname = dirname(__filename);
 
-const BASE_OUTPUT_DIR = resolve(__dirname, '../../public/api-reference');
+const BASE_OUTPUT_DIR = resolve(__dirname, '../../public/reference/javascript');
+
+const OUTPUT_DOCS_SRC_DIR = resolve(__dirname, '../../src');
 
 const typeDocConfigBaseOptions: Partial<TypeDocOptions> = {
   // TypeDoc options
@@ -154,7 +156,7 @@ async function generateIndexPage() {
   const indexTemplatePath = join(__dirname, 'indexTemplate.html');
   const indexContent = readFileSync(indexTemplatePath, 'utf-8')
     .replace('{{ pluginsGridHtml }}', pluginsGridHtml || '')
-    .replace('{{ tauriCard }}', cardTemplate('Tauri Core API', './core/index.html'));
+          .replace('{{ tauriCard }}', cardTemplate('Tauri Core API', '/reference/javascript/core/'));
 
   const assetsDir = join(BASE_OUTPUT_DIR, 'assets');
   if (!existsSync(assetsDir)) {
@@ -172,6 +174,25 @@ async function generateIndexPage() {
   }
   try {
     writeFileSync(indexPath, indexContent);
+    // Starlight  topics especific sidebar structure
+          const sidebar = [
+            {
+              label: 'Index',
+              link: '/reference/javascript/index.html',
+            },
+            {
+              label: 'Tauri Core API',
+              link: '/reference/javascript/core/index.html',
+            },
+            ...(pluginsGridHtml && existsSync(join(BASE_OUTPUT_DIR, 'plugins'))
+              ? readdirSync(join(BASE_OUTPUT_DIR, 'plugins')).map((plugin) => ({
+                  label: plugin,
+                  link: `/reference/javascript/plugins/${plugin}/index.html`,
+                }))
+              : []),
+          ];
+    const sidebarFilePath = join(OUTPUT_DOCS_SRC_DIR, '_generated-javascript-reference-sidebar.js');
+    writeFileSync(sidebarFilePath, 'export default ' + JSON.stringify(sidebar, null, 2) + ';\n');
   } catch (error) {
     console.error('Failed to write index files:', error);
   }

src/_generated-javascript-reference-sidebar.js

@@ -0,0 +1,110 @@
+export default [
+  {
+    "label": "Index",
+    "link": "/reference/javascript/index.html"
+  },
+  {
+    "label": "Tauri Core API",
+    "link": "/reference/javascript/core/index.html"
+  },
+  {
+    "label": "autostart",
+    "link": "/reference/javascript/plugins/autostart/index.html"
+  },
+  {
+    "label": "barcode-scanner",
+    "link": "/reference/javascript/plugins/barcode-scanner/index.html"
+  },
+  {
+    "label": "biometric",
+    "link": "/reference/javascript/plugins/biometric/index.html"
+  },
+  {
+    "label": "cli",
+    "link": "/reference/javascript/plugins/cli/index.html"
+  },
+  {
+    "label": "clipboard-manager",
+    "link": "/reference/javascript/plugins/clipboard-manager/index.html"
+  },
+  {
+    "label": "deep-link",
+    "link": "/reference/javascript/plugins/deep-link/index.html"
+  },
+  {
+    "label": "dialog",
+    "link": "/reference/javascript/plugins/dialog/index.html"
+  },
+  {
+    "label": "fs",
+    "link": "/reference/javascript/plugins/fs/index.html"
+  },
+  {
+    "label": "global-shortcut",
+    "link": "/reference/javascript/plugins/global-shortcut/index.html"
+  },
+  {
+    "label": "http",
+    "link": "/reference/javascript/plugins/http/index.html"
+  },
+  {
+    "label": "log",
+    "link": "/reference/javascript/plugins/log/index.html"
+  },
+  {
+    "label": "nfc",
+    "link": "/reference/javascript/plugins/nfc/index.html"
+  },
+  {
+    "label": "notification",
+    "link": "/reference/javascript/plugins/notification/index.html"
+  },
+  {
+    "label": "opener",
+    "link": "/reference/javascript/plugins/opener/index.html"
+  },
+  {
+    "label": "os",
+    "link": "/reference/javascript/plugins/os/index.html"
+  },
+  {
+    "label": "positioner",
+    "link": "/reference/javascript/plugins/positioner/index.html"
+  },
+  {
+    "label": "process",
+    "link": "/reference/javascript/plugins/process/index.html"
+  },
+  {
+    "label": "shell",
+    "link": "/reference/javascript/plugins/shell/index.html"
+  },
+  {
+    "label": "sql",
+    "link": "/reference/javascript/plugins/sql/index.html"
+  },
+  {
+    "label": "store",
+    "link": "/reference/javascript/plugins/store/index.html"
+  },
+  {
+    "label": "stronghold",
+    "link": "/reference/javascript/plugins/stronghold/index.html"
+  },
+  {
+    "label": "updater",
+    "link": "/reference/javascript/plugins/updater/index.html"
+  },
+  {
+    "label": "upload",
+    "link": "/reference/javascript/plugins/upload/index.html"
+  },
+  {
+    "label": "websocket",
+    "link": "/reference/javascript/plugins/websocket/index.html"
+  },
+  {
+    "label": "window-state",
+    "link": "/reference/javascript/plugins/window-state/index.html"
+  }
+];