docusaurus-plugin-typedoc 1.0.1 → 1.0.3

package/README.md

@@ -4,12 +4,6 @@
 
 > A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.
 
-## Installation
-
-```shell
-  npm install docusaurus-plugin-typedoc --save-dev
-  ```
-
 ## 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.

package/dist/models.d.ts

@@ -1,5 +1,5 @@
 import { PluginOptions as TypedocPluginMarkdownOptions } from 'typedoc-plugin-markdown';
-import { PluginOptions as DocusaurusOptions } from './options/option-types';
+import { PluginOptions as DocusaurusOptions } from './types';
 export interface PluginOptions extends TypedocPluginMarkdownOptions, DocusaurusOptions {
     id: string;
 }

package/dist/options/index.d.ts

@@ -0,0 +1,7 @@
+/**
+ * All plugin types are exported from this module.
+ *
+ * @module
+ */
+export * as declarations from './declarations';
+export * as presets from './presets';

package/dist/options/index.js

@@ -0,0 +1,33 @@
+"use strict";
+/**
+ * All plugin types are exported from this module.
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.presets = exports.declarations = void 0;
+exports.declarations = __importStar(require("./declarations"));
+exports.presets = __importStar(require("./presets"));

package/dist/options/presets.d.ts

@@ -1,8 +1,7 @@
-declare const _default: {
+export declare const presets: {
     out: string;
     hideBreadcrumbs: boolean;
     hidePageHeader: boolean;
     entryFileName: string;
     plugin: string[];
 };
-export default _default;

package/dist/options/presets.js

@@ -1,6 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.default = {
+exports.presets = void 0;
+exports.presets = {
     out: './docs/api',
     hideBreadcrumbs: true,
     hidePageHeader: true,

package/dist/options.js

@@ -1,16 +1,14 @@
 "use strict";
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getPluginOptions = exports.DEFAULT_SIDEBAR_OPTIONS = void 0;
-const presets_1 = __importDefault(require("./options/presets"));
+exports.DEFAULT_SIDEBAR_OPTIONS = void 0;
+exports.getPluginOptions = getPluginOptions;
+const presets_1 = require("./options/presets");
 exports.DEFAULT_SIDEBAR_OPTIONS = {
     autoConfiguration: true,
     pretty: false,
 };
 const DEFAULT_PLUGIN_OPTIONS = {
-    ...presets_1.default,
+    ...presets_1.presets,
     id: 'default',
     sidebar: {
         ...exports.DEFAULT_SIDEBAR_OPTIONS,
@@ -30,4 +28,3 @@ function getPluginOptions(opts) {
     };
     return options;
 }
-exports.getPluginOptions = getPluginOptions;

package/dist/plugin.d.ts

@@ -1,4 +1,4 @@
-import { PluginOptions } from '.';
+import { PluginOptions } from './models';
 export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): Promise<{
     name: string;
     extendCli(cli: any): void;

package/dist/plugin.js

@@ -23,12 +23,14 @@ var __importStar = (this && this.__importStar) || function (mod) {
     return result;
 };
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.default = pluginDocusaurus;
 const fs = __importStar(require("fs"));
 const path = __importStar(require("path"));
 const typedoc_1 = require("typedoc");
 const options_1 = require("./options");
 const options = __importStar(require("./options/declarations"));
 const sidebar_1 = require("./sidebar");
+const adjust_basedir_1 = require("./utils/adjust-basedir");
 // store list of plugin ids when running multiple instances
 const apps = [];
 async function pluginDocusaurus(context, opts) {
@@ -54,7 +56,6 @@ async function pluginDocusaurus(context, opts) {
         },
     };
 }
-exports.default = pluginDocusaurus;
 /**
  * Initiates a new typedoc Application bootstrapped with plugin options
  */
@@ -62,30 +63,31 @@ async function generateTypedoc(context, opts) {
     const { siteDir } = context;
     const pluginOptions = (0, options_1.getPluginOptions)(opts);
     const { id, sidebar, ...optionsPassedToTypeDoc } = pluginOptions;
-    const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
+    const outputDir = path.join(siteDir, pluginOptions.out);
+    if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir, { recursive: true });
+    }
+    const app = (await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc));
     Object.entries(options).forEach(([name, option]) => {
         app.options.addDeclaration({
             name,
             ...option,
         });
     });
-    // attempt to handle docusaurus linkify bug https://github.com/facebook/docusaurus/issues/9048
-    app.renderer.on(typedoc_1.PageEvent.END, (event) => {
-        event.contents = event.contents
-            ?.replace(/\)\.\[/g, ') . [')
-            .replace(/\\<\[/g, ' \\<[');
-    });
-    const outputDir = app.options.getValue('out');
     if (sidebar?.autoConfiguration) {
         const docsPreset = context.siteConfig?.presets?.find((preset) => Boolean(preset[1]?.docs));
         app.renderer.postRenderAsyncJobs.push(async (output) => {
             if (output.navigation) {
                 const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
-                const baseDir = path
+                let baseDir = path
                     .relative(siteDir, outputDir)
                     .split(path.sep)
                     .slice(1)
                     .join('/');
+                const docsPresetPath = docsPreset ? docsPreset[1]?.docs?.path : null;
+                if (Boolean(docsPresetPath)) {
+                    baseDir = (0, adjust_basedir_1.adjustBaseDirectory)(baseDir, docsPresetPath);
+                }
                 const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, docsPreset ? docsPreset[1]?.docs?.numberPrefixParser : null);
                 fs.writeFileSync(sidebarPath, `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */

package/dist/sidebar.js

@@ -1,12 +1,11 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.getSidebar = void 0;
+exports.getSidebar = getSidebar;
 function getSidebar(navigation, basePath, numberPrefixParser) {
     return navigation
         .map((navigationItem) => getNavigationItem(navigationItem, basePath, numberPrefixParser))
         .filter((navItem) => Boolean(navItem));
 }
-exports.getSidebar = getSidebar;
 function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
     const parsedUrl = numberPrefixParser === false
         ? navigationItem.path

package/dist/types/index.d.ts

@@ -0,0 +1,6 @@
+/**
+ * All plugin types are exported from this module.
+ *
+ * @module
+ */
+export * from './options';

package/dist/types/index.js

@@ -0,0 +1,22 @@
+"use strict";
+/**
+ * All plugin types are exported from this module.
+ *
+ * @module
+ */
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __exportStar = (this && this.__exportStar) || function(m, exports) {
+    for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+__exportStar(require("./options"), exports);

package/dist/{options/option-types.d.ts → types/options.d.ts}

@@ -1,13 +1,5 @@
-import { ManuallyValidatedOption } from 'typedoc';
-declare module 'typedoc' {
-    interface TypeDocOptionMap {
-        sidebar: ManuallyValidatedOption<Sidebar>;
-    }
-}
 /**
  * Describes the options declared by the plugin.
- *
- * @category Options
  */
 export interface PluginOptions {
     /**
@@ -17,8 +9,6 @@ export interface PluginOptions {
 }
 /**
  *
- *
- * @category Options
  */
 export interface Sidebar {
     autoConfiguration: boolean;

package/dist/types/options.js

@@ -0,0 +1,2 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });

package/dist/utils/adjust-basedir.d.ts

@@ -0,0 +1,4 @@
+/**
+ * This method is designed to resolve the base directory paths for documentation presets.
+ */
+export declare function adjustBaseDirectory(originalPath: string, subPath: string): string;

package/dist/utils/adjust-basedir.js

@@ -0,0 +1,54 @@
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || function (mod) {
+    if (mod && mod.__esModule) return mod;
+    var result = {};
+    if (mod != null) for (var k in mod) if (k !== "default" && Object.prototype.hasOwnProperty.call(mod, k)) __createBinding(result, mod, k);
+    __setModuleDefault(result, mod);
+    return result;
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.adjustBaseDirectory = adjustBaseDirectory;
+const path = __importStar(require("path"));
+/**
+ * This method is designed to resolve the base directory paths for documentation presets.
+ */
+function adjustBaseDirectory(originalPath, subPath) {
+    // Normalize the paths to handle different path formats and OS differences
+    originalPath = path.normalize(originalPath);
+    subPath = path.normalize(subPath);
+    // Split the original path into an array of segments
+    const segments = originalPath.split(path.sep);
+    // Split the sub path into an array of segments and filter out ".." to handle relative paths
+    const subSegments = subPath
+        .split(path.sep)
+        .filter((segment) => segment !== '..');
+    // Find the index of the first sub path segment in the original path segments
+    const startIndex = segments.indexOf(subSegments[0]);
+    // Remove the sub path segments from the original path segments if found
+    if (startIndex !== -1) {
+        segments.splice(startIndex, subSegments.length);
+    }
+    // Join the segments back into a path and remove the leading slash if present
+    let newPath = segments.join(path.sep);
+    // Ensure there is no leading slash
+    if (newPath.startsWith(path.sep)) {
+        newPath = newPath.slice(1);
+    }
+    return newPath;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [
@@ -14,7 +14,7 @@
     "url": "git+https://github.com/typedoc2md/typedoc-plugin-markdown.git",
     "directory": "packages/docusaurus-plugin-typedoc"
   },
-  "homepage": "http://typedoc.org/plugins/docusaurus",
+  "homepage": "http://typedoc-plugin-markdown.org/plugins/docusaurus",
   "peerDependencies": {
     "typedoc-plugin-markdown": ">=4.0.0"
   },
@@ -35,7 +35,7 @@
     "plugin"
   ],
   "devDependencies": {
-    "@docusaurus/core": "^3.2.1",
-    "@docusaurus/types": "^3.2.1"
+    "@docusaurus/core": "^3.4.0",
+    "@docusaurus/types": "^3.4.0"
   }
 }

package/dist/options/option-types.js

@@ -1,3 +0,0 @@
-"use strict";
-// THIS FILE IS AUTO GENERATED FROM THE OPTIONS CONFIG. DO NOT EDIT DIRECTLY.
-Object.defineProperty(exports, "__esModule", { value: true });