docusaurus-plugin-typedoc 1.1.1 → 1.2.0

package/dist/index.d.ts

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

package/dist/types/options.d.ts

@@ -11,9 +11,6 @@ export interface PluginOptions {
      */
     sidebar: Sidebar;
 }
-/**
- *
- */
 export interface Sidebar {
     autoConfiguration: boolean;
     pretty: boolean;

package/dist/utils/get-sidebar.js

@@ -25,7 +25,7 @@ function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
     if (navigationItem.children?.length) {
         return {
             type: 'category',
-            label: `${navigationItem.title}`,
+            label: getNavigationLabel(navigationItem),
             items: getSidebar(navigationItem.children, basePath, numberPrefixParser),
             ...(id && {
                 link: {
@@ -39,7 +39,18 @@ function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
         ? {
             type: 'doc',
             id,
-            label: `${navigationItem.title}`,
+            label: getNavigationLabel(navigationItem),
         }
         : null;
 }
+function getNavigationLabel(navigationItem) {
+    return navigationItem.isDeprecated
+        ? strikethrough(navigationItem.title)
+        : navigationItem.title;
+}
+function strikethrough(label) {
+    return label
+        .split('')
+        .map((char) => char + '\u0336')
+        .join('');
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.1.1",
+  "version": "1.2.0",
   "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",