docusaurus-plugin-typedoc 1.0.0-next.17 → 1.0.0-next.19

package/README.md

@@ -122,7 +122,7 @@ Pretty format the sidebar JSON.
 
 > Previous versions of this plugin recommended an `autogenerated` sidebar configuration. However we have decided it is more deterministic and configurable to use a manual sidebar configuration with a generated sidebar file.
 
-A docusaurus sidebar file `typedoc-sidebar.cjs` is published to the relevant output directory along with the generated markdown documentation.
+A docusaurus sidebar file `typedoc-sidebar.js` is published to the relevant output directory along with the generated markdown documentation.
 
 This file should be referenced in `sidebars.js` using a sidebar slice and can be configured in following ways:
 
@@ -130,7 +130,7 @@ This file should be referenced in `sidebars.js` using a sidebar slice and can be
 
 ```js
 module.exports = {
-  typedocSidebar: require('./docs/api/typedoc-sidebar.cjs'),
+  typedocSidebar: require('./docs/api/typedoc-sidebar.js'),
 };
 ```
 
@@ -139,7 +139,7 @@ module.exports = {
 ```js
 module.exports = {
   typedocSidebar: {
-    'Typedoc Docs': require('./docs/api/typedoc-sidebar.cjs'),
+    'Typedoc Docs': require('./docs/api/typedoc-sidebar.js'),
   },
 };
 ```
@@ -158,7 +158,7 @@ module.exports = {
         type: 'doc',
         id: 'api/index',
       },
-      items: require('./docs/api/typedoc-sidebar.cjs'),
+      items: require('./docs/api/typedoc-sidebar.js'),
     },
   ],
 };
@@ -225,8 +225,8 @@ module.exports = {
 ```js
 module.exports = {
   typedocSidebar: {
-    'API 1': require('./docs/api-1/typedoc-sidebar.cjs'),
-    'API 2': require('./docs/api-2/typedoc-sidebar.cjs'),
+    'API 1': require('./docs/api-1/typedoc-sidebar.js'),
+    'API 2': require('./docs/api-2/typedoc-sidebar.js'),
   },
 };
 ```

package/dist/plugin.js

@@ -61,6 +61,7 @@ exports.default = pluginDocusaurus;
  * Initiates a new typedoc Application bootstraped with plugin options
  */
 async function generateTypedoc(context, opts) {
+    var _a, _b;
     const { siteDir } = context;
     const options = (0, options_1.getPluginOptions)(opts);
     const { id, sidebar, ...optionsPassedToTypeDoc } = options;
@@ -69,18 +70,20 @@ async function generateTypedoc(context, opts) {
     if (options.cleanOutputDir) {
         removeDir(outputDir);
     }
-    app.renderer.on(typedoc_1.PageEvent.END, (event) => {
-        var _a;
-        event.contents = (_a = event.contents) === null || _a === void 0 ? void 0 : _a.replace(/\\</g, '<');
-    });
+    if (((_b = (_a = context.siteConfig) === null || _a === void 0 ? void 0 : _a.markdown) === null || _b === void 0 ? void 0 : _b.format) !== 'mdx') {
+        app.renderer.on(typedoc_1.PageEvent.END, (event) => {
+            var _a;
+            event.contents = (_a = event.contents) === null || _a === void 0 ? void 0 : _a.replace(/\\</g, '<');
+        });
+    }
     if (sidebar === null || sidebar === void 0 ? void 0 : sidebar.autoConfiguration) {
         app.renderer.postRenderAsyncJobs.push(async (output) => {
-            const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
+            const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.js');
             const baseDir = path
                 .relative(siteDir, outputDir)
-                .split('/')
+                .split(path.sep)
                 .slice(1)
-                .join('/');
+                .join(path.sep);
             const sidebarJson = (0, sidebar_1.getSidebar)(output.navigation, baseDir, sidebar.filteredIds);
             fs.writeFileSync(sidebarPath, `// @ts-check
 /** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.17",
-  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
+  "version": "1.0.0-next.19",
+  "description": "A Docusaurus plugin to build API documentation with TypeDoc.",
   "main": "dist/index.js",
   "files": [
     "dist/"
@@ -16,7 +16,7 @@
   },
   "homepage": "https://github.com/tgreyuk/typedoc-plugin-markdown/tree/master/packages/docusaurus-plugin-typedoc",
   "peerDependencies": {
-    "typedoc-plugin-markdown": ">=4.0.0-next.22"
+    "typedoc-plugin-markdown": ">=4.0.0-next.24"
   },
   "scripts": {
     "lint": "eslint ./src --ext .ts",
@@ -34,7 +34,7 @@
     "typescript",
     "api"
   ],
-  "dependencies": {
-    "@docusaurus/types": "^2.4.1"
+  "devDependencies": {
+    "@docusaurus/types": "^3.0.0"
   }
 }