docusaurus-plugin-typedoc 1.0.0-next.29 → 1.0.0-next.30

package/README.md

@@ -2,7 +2,7 @@
 
 ![npm](https://img.shields.io/npm/v/docusaurus-plugin-typedoc%2Fnext?&logo=npm) [![Build Status](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml/badge.svg?branch=next)](https://github.com/tgreyuk/typedoc-plugin-markdown/actions/workflows/ci.yml)
 
-A Docusaurus plugin to integrate TypeDoc into a Docusaurus project.
+A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.
 
 ## Installation
 

package/dist/options/declarations.d.ts

@@ -1,8 +1,5 @@
 import { ParameterType } from 'typedoc';
 /**
- *
- * > *In addition to the sidebar options listed below, you can configure the structure of the sidebar by utilizing the TypeDoc [`navigation options`](https://typedoc.org/options/output/#navigation) `includeGroups`, `includeCategories` and `includeFolders`*.
- *
  * **sidebar.autoConfiguration**
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
@@ -13,18 +10,6 @@ import { ParameterType } from 'typedoc';
  *
  * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
  *
- * ```json filename="Example"
- * "navigation": {
- *   "includeGroups": true,
- *   "includeCategories": true
- * },
- * "sidebar": {
- *   "pretty": true
- * }
- * ```
- *
- * @omitExample
- *
  */
 export declare const sidebar: {
     help: string;

package/dist/options/declarations.js

@@ -4,9 +4,6 @@ exports.sidebar = void 0;
 const typedoc_1 = require("typedoc");
 const options_1 = require("../options");
 /**
- *
- * > *In addition to the sidebar options listed below, you can configure the structure of the sidebar by utilizing the TypeDoc [`navigation options`](https://typedoc.org/options/output/#navigation) `includeGroups`, `includeCategories` and `includeFolders`*.
- *
  * **sidebar.autoConfiguration**
  *
  * Set to `false` to disable sidebar generation. Defaults to `true`.
@@ -17,18 +14,6 @@ const options_1 = require("../options");
  *
  * Please see the [sidebar guide](/plugins/docusaurus/guide/sidebar) for additional information on sidebar setup.
  *
- * ```json filename="Example"
- * "navigation": {
- *   "includeGroups": true,
- *   "includeCategories": true
- * },
- * "sidebar": {
- *   "pretty": true
- * }
- * ```
- *
- * @omitExample
- *
  */
 exports.sidebar = {
     help: 'Configures the autogenerated Docusaurus sidebar.',

package/dist/plugin.js

@@ -56,12 +56,12 @@ async function pluginDocusaurus(context, opts) {
 }
 exports.default = pluginDocusaurus;
 /**
- * Initiates a new typedoc Application bootstraped with plugin options
+ * Initiates a new typedoc Application bootstrapped with plugin options
  */
 async function generateTypedoc(context, opts) {
     const { siteDir } = context;
-    const pluginOpions = (0, options_1.getPluginOptions)(opts);
-    const { id, sidebar, ...optionsPassedToTypeDoc } = pluginOpions;
+    const pluginOptions = (0, options_1.getPluginOptions)(opts);
+    const { id, sidebar, ...optionsPassedToTypeDoc } = pluginOptions;
     const app = await typedoc_1.Application.bootstrapWithPlugins(optionsPassedToTypeDoc);
     Object.entries(options).forEach(([name, option]) => {
         app.options.addDeclaration({
@@ -75,8 +75,6 @@ async function generateTypedoc(context, opts) {
         app.renderer.postRenderAsyncJobs.push(async (output) => {
             if (output.navigation) {
                 const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
-                const sidebarJSONPath = path.resolve(outputDir, 'typedoc-sidebar.json');
-                fs.writeFileSync(sidebarJSONPath, JSON.stringify(output.navigation, null, 2));
                 const baseDir = path
                     .relative(siteDir, outputDir)
                     .split(path.sep)

package/dist/sidebar.js

@@ -17,7 +17,7 @@ function getNavigationItem(navigationItem, basePath, numberPrefixParser) {
             idParts.push(basePath);
         }
         if (parsedUrl) {
-            idParts.push(parsedUrl);
+            idParts.push(parsedUrl.replace(/\\/g, '/'));
         }
         if (navigationItem.path) {
             return idParts.join('/').replace(/(.*)\.\w+$/, '$1');

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "docusaurus-plugin-typedoc",
-  "version": "1.0.0-next.29",
+  "version": "1.0.0-next.30",
   "description": "A Docusaurus plugin to integrate TypeDoc ( + typedoc-plugin-markdown ) into a Docusaurus project.",
   "main": "dist/index.js",
   "files": [