docusaurus-plugin-typedoc 1.1.1 → 1.2.1

package/dist/index.d.ts

@@ -1,2 +1,5 @@
+/**
+ * @module core
+ */
 export { PluginOptions } from './models.js';
 export { default } from './plugins/docusaurus.js';

package/dist/options/declarations.d.ts

@@ -8,14 +8,18 @@ import { DeclarationOption } from 'typedoc';
  */
 export declare const docusaurusConfigOptions: Partial<DeclarationOption>;
 /**
- * **sidebar.autoConfiguration**
+ * **autoConfiguration**
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
  *
- * **sidebar.pretty**
+ * **pretty**
  *
  * Pretty format the sidebar JSON.
  *
+ * **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.
  *
  */

package/dist/options/declarations.js

@@ -13,14 +13,18 @@ export const docusaurusConfigOptions = {
     defaultValue: '{}',
 };
 /**
- * **sidebar.autoConfiguration**
+ * **autoConfiguration**
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
  *
- * **sidebar.pretty**
+ * **pretty**
  *
  * Pretty format the sidebar JSON.
  *
+ * **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.
  *
  */
@@ -28,4 +32,13 @@ export const sidebar = {
     help: 'Configures the autogenerated Docusaurus sidebar.',
     type: ParameterType.Mixed,
     defaultValue: DEFAULT_SIDEBAR_OPTIONS,
+    validate(value) {
+        if (typeof value !== 'object') {
+            console.warn('[typedoc-plugin-markdown] Sidebar must be an object.');
+        }
+        const invalidKeys = Object.keys(value).filter((key) => !Object.keys(DEFAULT_SIDEBAR_OPTIONS).includes(key));
+        if (invalidKeys.length > 0) {
+            console.warn(`[typedoc-plugin-markdown] Invalid keys in sidebar options: ${invalidKeys.join(', ')}`);
+        }
+    },
 };

package/dist/options/options.d.ts

@@ -1,5 +1,6 @@
 export declare const DEFAULT_SIDEBAR_OPTIONS: {
     autoConfiguration: boolean;
     pretty: 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,
+    deprecatedItemClassName: 'typedoc-sidebar-item-deprecated',
 };
 const DEFAULT_PLUGIN_OPTIONS = {
     ...presets,

package/dist/plugins/typedoc.js

@@ -46,7 +46,7 @@ export function load(app) {
             if (docsPresetPath) {
                 baseDir = adjustBaseDirectory(baseDir, docsPresetPath);
             }
-            const sidebarJson = getSidebar(output.navigation, baseDir, numberPrefixParser);
+            const sidebarJson = getSidebar(output.navigation, baseDir, sidebar, numberPrefixParser);
             fs.writeFileSync(sidebarPath, `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
 const typedocSidebar = { items: ${JSON.stringify(sidebarJson, null, sidebar.pretty ? 2 : 0)}};

package/dist/types/options.d.ts

@@ -11,10 +11,8 @@ export interface PluginOptions {
      */
     sidebar: Sidebar;
 }
-/**
- *
- */
 export interface Sidebar {
     autoConfiguration: boolean;
     pretty: boolean;
+    deprecatedItemClassName: string;
 }

package/dist/utils/get-sidebar.d.ts

@@ -1,2 +1,3 @@
 import { NavigationItem } from 'typedoc-plugin-markdown';
-export declare function getSidebar(navigation: NavigationItem[], basePath: string, numberPrefixParser?: any): any;
+import { Sidebar } from '../types/options.js';
+export declare function getSidebar(navigation: NavigationItem[], basePath: string, options: Sidebar, numberPrefixParser?: any): any;

package/dist/utils/get-sidebar.js

@@ -1,9 +1,9 @@
-export function getSidebar(navigation, basePath, numberPrefixParser) {
+export function getSidebar(navigation, basePath, options, numberPrefixParser) {
     return navigation
-        .map((navigationItem) => getNavigationItem(navigationItem, basePath, numberPrefixParser))
+        .map((navigationItem) => getNavigationItem(navigationItem, basePath, options, numberPrefixParser))
         .filter((navItem) => Boolean(navItem));
 }
-function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
+function getNavigationItem(navigationItem, basePath, options, numberPrefixParser) {
     const navigationItemPath = navigationItem.path || navigationItem.url;
     const parsedUrl = numberPrefixParser === false
         ? navigationItemPath
@@ -25,8 +25,8 @@ function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
     if (navigationItem.children?.length) {
         return {
             type: 'category',
-            label: `${navigationItem.title}`,
-            items: getSidebar(navigationItem.children, basePath, numberPrefixParser),
+            label: navigationItem.title,
+            items: getSidebar(navigationItem.children, basePath, options, numberPrefixParser),
             ...(id && {
                 link: {
                     type: 'doc',
@@ -39,7 +39,10 @@ function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
         ? {
             type: 'doc',
             id,
-            label: `${navigationItem.title}`,
+            label: navigationItem.title,
+            ...(navigationItem.isDeprecated && {
+                className: options.deprecatedItemClassName,
+            }),
         }
         : null;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "exports": {
     ".": "./dist/index.js",
@@ -20,7 +20,7 @@
   },
   "homepage": "http://typedoc-plugin-markdown.org/plugins/docusaurus",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.3.0"
+    "typedoc-plugin-markdown": ">=4.4.0"
   },
   "scripts": {
     "lint": "eslint ./src",