docusaurus-plugin-typedoc 0.17.0 → 0.17.2

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 CHANGED
@@ -103,7 +103,6 @@ Options specific to the plugin should also be declared in the same object.
103
103
  | `sidebar.categoryLabel` | `API` | The sidebar parent category label. |
104
104
  | `sidebar.fullNames` | `false` | Display full names with module path. |
105
105
  | `sidebar.position` | `auto` | The position of the sidebar in the tree. |
106
- | `sidebar.position` | `auto` | The position of the sidebar in the tree. |
107
106
 
108
107
  ### An example configuration
109
108
 
@@ -229,6 +228,7 @@ module.exports = {
229
228
  id: 'api-1',
230
229
  entryPoints: ['../api-1/src/index.ts'],
231
230
  tsconfig: '../api-1/tsconfig.json',
231
+ out: 'api-1',
232
232
  },
233
233
  ],
234
234
  [
@@ -237,6 +237,7 @@ module.exports = {
237
237
  id: 'api-2',
238
238
  entryPoints: ['../api-2/src/index.ts'],
239
239
  tsconfig: '../api-2/tsconfig.json',
240
+ out: 'api-2',
240
241
  },
241
242
  ],
242
243
  ],
package/dist/options.js CHANGED
@@ -5,6 +5,7 @@ const DEFAULT_PLUGIN_OPTIONS = {
5
5
  id: 'default',
6
6
  docsRoot: 'docs',
7
7
  out: 'api',
8
+ cleanOutputDir: true,
8
9
  sidebar: {
9
10
  fullNames: false,
10
11
  categoryLabel: 'API',
package/dist/plugin.d.ts CHANGED
@@ -1,6 +1,5 @@
1
- import { LoadContext } from '@docusaurus/types';
2
1
  import { PluginOptions } from './types';
3
- export default function pluginDocusaurus(context: LoadContext, opts: Partial<PluginOptions>): {
2
+ export default function pluginDocusaurus(context: any, opts: Partial<PluginOptions>): {
4
3
  name: string;
5
4
  loadContent(): Promise<void>;
6
5
  };
package/dist/plugin.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
@@ -35,7 +39,9 @@ function pluginDocusaurus(context, opts) {
35
39
  const { siteDir } = context;
36
40
  const options = (0, options_1.getPluginOptions)(opts);
37
41
  const outputDir = path.resolve(siteDir, options.docsRoot, options.out);
38
- (0, render_1.removeDir)(outputDir);
42
+ if (opts.cleanOutputDir) {
43
+ (0, render_1.removeDir)(outputDir);
44
+ }
39
45
  const app = new typedoc_1.Application();
40
46
  app.renderer.defineTheme('docusaurus', theme_1.DocusaurusTheme);
41
47
  (0, typedoc_plugin_markdown_1.load)(app);
package/dist/render.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/dist/theme.js CHANGED
@@ -1,7 +1,11 @@
1
1
  "use strict";
2
2
  var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
3
3
  if (k2 === undefined) k2 = k;
4
- Object.defineProperty(o, k2, { enumerable: true, get: function() { return m[k]; } });
4
+ var desc = Object.getOwnPropertyDescriptor(m, k);
5
+ if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
6
+ desc = { enumerable: true, get: function() { return m[k]; } };
7
+ }
8
+ Object.defineProperty(o, k2, desc);
5
9
  }) : (function(o, m, k, k2) {
6
10
  if (k2 === undefined) k2 = k;
7
11
  o[k2] = m[k];
package/dist/types.d.ts CHANGED
@@ -8,6 +8,7 @@ export interface PluginOptions {
8
8
  plugin: string[];
9
9
  readme?: string;
10
10
  disableOutputCheck?: boolean;
11
+ cleanOutputDir?: boolean;
11
12
  entryPoints?: string[];
12
13
  watch: boolean;
13
14
  hideInPageTOC: boolean;
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "docusaurus-plugin-typedoc",
3
- "version": "0.17.0",
3
+ "version": "0.17.2",
4
4
  "description": "A Docusaurus v2 plugin to build API documentation with TypeDoc.",
5
5
  "main": "dist/index.js",
6
6
  "files": [
@@ -19,18 +19,15 @@
19
19
  "typedoc": ">=0.22.0",
20
20
  "typedoc-plugin-markdown": ">=3.11.10"
21
21
  },
22
- "devDependencies": {
23
- "@docusaurus/types": "^2.0.0-beta.0"
24
- },
25
22
  "scripts": {
26
23
  "lint": "eslint ./src --ext .ts",
27
24
  "prepublishOnly": "yarn run lint && yarn run build && yarn run test",
28
25
  "build": "rm -rf ./dist && tsc",
29
26
  "build-and-test": "yarn run build && yarn run test",
30
- "test:init": "rm -rf test/site && npx @docusaurus/init@latest init test/site classic",
27
+ "test:init": "rm -rf test/site && npx npx create-docusaurus@latest test/site classic",
31
28
  "test:demo:start": "yarn run build && cd test/site && yarn run start",
32
29
  "test:demo:build": "yarn run build && cd test/site && yarn run build && yarn run serve",
33
- "test": "jest --colors --updateSnapshot"
30
+ "test": "jest --colors"
34
31
  },
35
32
  "author": "Thomas Grey",
36
33
  "license": "MIT",
@@ -42,5 +39,5 @@
42
39
  "typescript",
43
40
  "api"
44
41
  ],
45
- "gitHead": "39b0da170611c2e27c821ef2f1869ff2e4bb0125"
42
+ "gitHead": "34c68d8adcb9ba75af53f35dcf830caec4020be7"
46
43
  }