docusaurus-plugin-typedoc 1.2.3 → 1.3.1

package/README.md

@@ -6,7 +6,7 @@
 
 ## Documentation
 
-Please visit the [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
+Please visit [https://typedoc-plugin-markdown.org/plugins/docusaurus](https://typedoc-plugin-markdown.org/plugins/docusaurus) for comprehensive documentation, including options and usage guides.
 
 ## License
 

package/dist/options/declarations.d.ts

@@ -4,15 +4,38 @@ import { DeclarationOption } from 'typedoc';
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
  *
+ * **typescript**
+ *
+ * Set to `true` to generate a TypeScript file. Defaults to `false` (CommonJs).
+ *
  * **pretty**
  *
- * Pretty format the sidebar JSON.
+ * Pretty format the sidebar JSON. Defaults to `false`.
  *
  * **deprecatedItemClassName**
  *
  * The class name to apply to deprecated items in the sidebar. Defaults to `"typedoc-sidebar-item-deprecated"`.
  *
- * Please see the [sidebar guide](https:/typedoc-plugin-markdown.org/plugins/docusaurus/sidebar) for additional information on sidebar setup.
+ * Please see the [sidebar guide](/plugins/docusaurus/guides/sidebar) for additional information on sidebar setup.
+ *
+ * ```js  filename="docusaurus.config.js"
+ * {
+ *   plugins: [
+ *     [
+ *       'docusaurus-plugin-typedoc',
+ *       {
+ *         "sidebar": {
+ *           "autoConfiguration": true,
+ *           "pretty": false,
+ *           "typescript": false,
+ *           "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ *
+ * @omitExample
  *
  */
 export declare const sidebar: Partial<DeclarationOption>;

package/dist/options/declarations.js

@@ -5,15 +5,38 @@ import { DEFAULT_SIDEBAR_OPTIONS } from './options.js';
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
  *
+ * **typescript**
+ *
+ * Set to `true` to generate a TypeScript file. Defaults to `false` (CommonJs).
+ *
  * **pretty**
  *
- * Pretty format the sidebar JSON.
+ * Pretty format the sidebar JSON. Defaults to `false`.
  *
  * **deprecatedItemClassName**
  *
  * The class name to apply to deprecated items in the sidebar. Defaults to `"typedoc-sidebar-item-deprecated"`.
  *
- * Please see the [sidebar guide](https:/typedoc-plugin-markdown.org/plugins/docusaurus/sidebar) for additional information on sidebar setup.
+ * Please see the [sidebar guide](/plugins/docusaurus/guides/sidebar) for additional information on sidebar setup.
+ *
+ * ```js  filename="docusaurus.config.js"
+ * {
+ *   plugins: [
+ *     [
+ *       'docusaurus-plugin-typedoc',
+ *       {
+ *         "sidebar": {
+ *           "autoConfiguration": true,
+ *           "pretty": false,
+ *           "typescript": false,
+ *           "deprecatedItemClassName": "typedoc-sidebar-item-deprecated"
+ *         }
+ *       }
+ *     ]
+ *   ]
+ * }
+ *
+ * @omitExample
  *
  */
 export const sidebar = {

package/dist/options/options.d.ts

@@ -1,6 +1,7 @@
 export declare const DEFAULT_SIDEBAR_OPTIONS: {
     autoConfiguration: boolean;
     pretty: boolean;
+    typescript: boolean;
     deprecatedItemClassName: string;
 };
 export declare function getPluginOptions(context: any, opts: Record<string, any>): Record<string, any>;

package/dist/options/options.js

@@ -2,6 +2,7 @@ import { presets } from './presets.js';
 export const DEFAULT_SIDEBAR_OPTIONS = {
     autoConfiguration: true,
     pretty: false,
+    typescript: false,
     deprecatedItemClassName: 'typedoc-sidebar-item-deprecated',
 };
 const DEFAULT_PLUGIN_OPTIONS = {

package/dist/plugin/sidebar.js

@@ -3,21 +3,28 @@ import * as path from 'path';
 import { adjustBaseDirectory } from '../utils/adjust-basedir.js';
 export function writeSidebar(navigation, outputDir, sidebar, siteDir, docsPresetPath, numberPrefixParser) {
     if (sidebar?.autoConfiguration) {
-        const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
-        let baseDir = path
-            .relative(siteDir, outputDir)
-            .split(path.sep)
-            .slice(1)
-            .join('/');
-        if (docsPresetPath) {
-            baseDir = adjustBaseDirectory(baseDir, docsPresetPath);
-        }
+        const sidebarFileName = sidebar.typescript
+            ? 'typedoc-sidebar.ts'
+            : 'typedoc-sidebar.cjs';
+        const sidebarPath = path.resolve(outputDir, sidebarFileName);
+        const baseDir = adjustBaseDirectory(path.relative(siteDir, outputDir).split(path.sep).join('/'), docsPresetPath || 'docs');
         const sidebarJson = getSidebar(navigation, baseDir, sidebar, numberPrefixParser);
-        fs.writeFileSync(sidebarPath, `// @ts-check
+        const sidebarContent = sidebar.typescript
+            ? getTypescriptSidebar(sidebarJson, sidebar)
+            : getJsSidebar(sidebarJson, sidebar);
+        fs.writeFileSync(sidebarPath, sidebarContent);
+    }
+}
+function getTypescriptSidebar(sidebarJson, sidebar) {
+    return `import { SidebarsConfig } from '@docusaurus/plugin-content-docs';
+const typedocSidebar: SidebarsConfig = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};
+export default typedocSidebar;`;
+}
+function getJsSidebar(sidebarJson, sidebar) {
+    return `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const typedocSidebar = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};
-module.exports = typedocSidebar.items;`);
-    }
+module.exports = typedocSidebar.items;`;
 }
 function getSidebar(navigation, basePath, options, numberPrefixParser) {
     return navigation

package/dist/types/options.d.ts

@@ -2,17 +2,14 @@
  * Describes the options declared by the plugin.
  */
 export interface PluginOptions {
-    /**
-     * docusaurus.config options - should not be used if running as a docusaurus plugin.
-     */
-    docusaurusConfigOptions: string;
     /**
      * Configures the autogenerated Docusaurus sidebar.
      */
-    sidebar: Sidebar;
+    sidebar?: Sidebar;
 }
 export interface Sidebar {
     autoConfiguration: boolean;
     pretty: boolean;
+    typescript: boolean;
     deprecatedItemClassName: string;
 }

package/dist/types/options.js

@@ -1 +1,4 @@
+/*
+ * THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY
+ */
 export {};

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.2.3",
+  "version": "1.3.1",
   "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "exports": {
     ".": "./dist/index.js"
@@ -19,14 +19,13 @@
   },
   "homepage": "http://typedoc-plugin-markdown.org/plugins/docusaurus",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.4.0"
+    "typedoc-plugin-markdown": ">=4.6.0"
   },
   "scripts": {
     "lint": "eslint ./src",
-    "prebuild": "rm -rf dist && copyfiles --up 1 ./src/**/*.cjs ./dist/",
+    "prebuild": "rm -rf dist && prebuild-options && copyfiles --up 1 ./src/**/*.cjs ./dist/",
     "prepublishOnly": "npm run lint && npm run build",
     "build": "tsc",
-    "pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
     "test": "jest",
     "test:update": "npm run build && npm test -- -u"
   },
@@ -36,9 +35,5 @@
     "docusaurus",
     "typedoc",
     "plugin"
-  ],
-  "devDependencies": {
-    "@docusaurus/core": "^3.7.0",
-    "@docusaurus/types": "^3.7.0"
-  }
+  ]
 }