website: hasApi

website/README.md

@@ -29,5 +29,3 @@ categories or groups.
 [!NOTE]
 There is also another plugin, `docusaurus-plugin-typedoc-api`, but
 it is no longer maintained.
-
-1

website/docusaurus.config.ts

@@ -155,6 +155,46 @@ const config: Config = {
         disableInDev: false,
       },
     ],
+    [
+      'docusaurus-plugin-typedoc',
+      {
+        // https://typedoc-plugin-markdown.org/docs/options#display-options
+        blockTagsPreserveOrder: [
+          "@example"
+        ],
+        categorizeByGroup: false, // Otherwise it fails to load the sidebar.
+        classPropertiesFormat: "list", // "table" not, it may have examples
+        entryPointStrategy: "resolve",
+        entryPoints: [
+          "../src/index.ts"
+        ],
+        enumMembersFormat: "table",
+        excludeExternals: true,
+        excludeInternal: true,
+        expandObjects: true,
+        expandParameters: true,
+        indexFormat: "table",
+        interfacePropertiesFormat: "list", // "table" not, it may have examples
+        logLevel: "Verbose",
+        parametersFormat: "table",
+        plugin: [
+          "typedoc-plugin-markdown"
+        ],
+        propertyMembersFormat: "table",
+        readme: "none",
+        skipErrorChecking: true,
+        sort: [
+          "instance-first",
+          "visibility"
+        ],
+        tsconfig: '../tsconfig.json',
+        "tableColumnSettings": {
+          "leftAlignHeaders": true
+        },
+        typeDeclarationFormat: "table",
+        useCodeBlocks: false, // Nice, but it might be mistaken for examples.
+      }
+    ],
 
     // Local plugins.
     './src/plugins/SelectReleasesPlugin',
@@ -263,6 +303,11 @@ const config: Config = {
           ],
         },
         cliNavbar,
+        {
+          to: '/docs/api',
+          label: 'API Reference',
+          position: 'left',
+        },
         {
           type: 'dropdown',
           to: '/blog',
@@ -384,6 +429,4 @@ const config: Config = {
   customFields: customFields,
 };
 
-logger.info(config.baseUrl);
-
 export default config;

website/package.json

@@ -64,6 +64,7 @@
     "metadataDescription": "The xPack Component Manager command line tool",
     "metadataKeywords": "xcdl, xpack, components, manager, cli, cdl, ecos",
     "hasCli": "true",
+    "hasApi": "true",
     "isInstallGlobally": "true",
     "shareOnTwitter": "true",
     "hasTopHomepageFeatures": "true",

website/sidebars.ts

@@ -2,6 +2,7 @@
 // Automatically generated from docusaurus-template-liquid/templates/docusaurus.
 
 import type {SidebarsConfig} from '@docusaurus/plugin-content-docs';
+import typedocSidebarItems from "./docs/api/typedoc-sidebar.cjs";
 import cliSidebar from "./sidebar-cli";
 import {userSidebarCategory} from "./sidebar-user";
 
@@ -78,6 +79,17 @@ const sidebars: SidebarsConfig = {
       label: 'Maintainer Information'
     },
   ],
+  typedocSidebar: [
+    {
+      type: "category",
+      label: "API Reference (TypeDoc)",
+      link: {
+        type: "doc",
+        id: "api/index",
+      },
+      items: typedocSidebarItems,
+    },
+  ],
   cliSidebar
 
 };