docusaurus-plugin-typedoc 1.0.0-next.19 → 1.0.0-next.20
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +2 -2
- package/dist/plugin.js +1 -1
- package/dist/sidebar.js +1 -1
- package/package.json +1 -1
package/README.md
CHANGED
|
@@ -122,7 +122,7 @@ Pretty format the sidebar JSON.
|
|
|
122
122
|
|
|
123
123
|
> 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.
|
|
124
124
|
|
|
125
|
-
A docusaurus sidebar file `typedoc-sidebar.
|
|
125
|
+
A docusaurus sidebar file `typedoc-sidebar.cjs` is published to the relevant output directory along with the generated markdown documentation.
|
|
126
126
|
|
|
127
127
|
This file should be referenced in `sidebars.js` using a sidebar slice and can be configured in following ways:
|
|
128
128
|
|
|
@@ -130,7 +130,7 @@ This file should be referenced in `sidebars.js` using a sidebar slice and can be
|
|
|
130
130
|
|
|
131
131
|
```js
|
|
132
132
|
module.exports = {
|
|
133
|
-
typedocSidebar: require('./docs/api/typedoc-sidebar.
|
|
133
|
+
typedocSidebar: require('./docs/api/typedoc-sidebar.cjs'),
|
|
134
134
|
};
|
|
135
135
|
```
|
|
136
136
|
|
package/dist/plugin.js
CHANGED
|
@@ -78,7 +78,7 @@ async function generateTypedoc(context, opts) {
|
|
|
78
78
|
}
|
|
79
79
|
if (sidebar === null || sidebar === void 0 ? void 0 : sidebar.autoConfiguration) {
|
|
80
80
|
app.renderer.postRenderAsyncJobs.push(async (output) => {
|
|
81
|
-
const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.
|
|
81
|
+
const sidebarPath = path.resolve(outputDir, 'typedoc-sidebar.cjs');
|
|
82
82
|
const baseDir = path
|
|
83
83
|
.relative(siteDir, outputDir)
|
|
84
84
|
.split(path.sep)
|
package/dist/sidebar.js
CHANGED
|
@@ -10,7 +10,7 @@ exports.getSidebar = getSidebar;
|
|
|
10
10
|
function getNavigationItem(navigationItem, basePath, filteredIds) {
|
|
11
11
|
var _a;
|
|
12
12
|
const id = navigationItem.url
|
|
13
|
-
? `${basePath}/${navigationItem.url}`.replace(/(.*).md/, '$1')
|
|
13
|
+
? `${basePath}/${navigationItem.url.replace(/\d+\-/g, '')}`.replace(/(.*).md/, '$1')
|
|
14
14
|
: null;
|
|
15
15
|
if ((_a = navigationItem.children) === null || _a === void 0 ? void 0 : _a.length) {
|
|
16
16
|
return {
|