docusaurus-plugin-typedoc 1.4.1 → 1.4.3
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 +22 -4
- package/dist/plugin.js +1 -0
- package/package.json +13 -10
package/README.md
CHANGED
|
@@ -1,13 +1,31 @@
|
|
|
1
1
|
# docusaurus-plugin-typedoc
|
|
2
2
|
|
|
3
|
-
[](https://www.npmjs.com/package/docusaurus-plugin-typedoc) [](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.yml)
|
|
3
|
+
[](https://www.npmjs.com/package/docusaurus-plugin-typedoc) [](https://www.npmjs.com/package/docusaurus-plugin-typedoc) [](https://github.com/typedoc2md/typedoc-plugin-markdown/actions/workflows/ci.docusaurus-plugin-typedoc.yml)
|
|
4
4
|
|
|
5
|
-
|
|
5
|
+
## Overview
|
|
6
|
+
|
|
7
|
+
**`docusaurus-plugin-typedoc`** runs TypeDoc as part of the Docusaurus toolchain, so API docs can be generated during the normal Docusaurus dev and build flow.
|
|
8
|
+
|
|
9
|
+
Use it when you want Docusaurus to own the TypeDoc execution step instead of maintaining a separate docs generation command.
|
|
10
|
+
|
|
11
|
+
Internally, it uses **`typedoc-docusaurus-theme`** to generate Docusaurus-compatible Markdown and sidebar data.
|
|
12
|
+
|
|
13
|
+
## Installation
|
|
14
|
+
|
|
15
|
+
```shell
|
|
16
|
+
npm install typedoc typedoc-plugin-markdown docusaurus-plugin-typedoc --save-dev
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
## Features
|
|
20
|
+
|
|
21
|
+
- Bootstraps TypeDoc from the Docusaurus CLI.
|
|
22
|
+
- Uses `typedoc-docusaurus-theme` internally for Docusaurus-compatible output.
|
|
23
|
+
- Supports generating API docs as part of the standard Docusaurus workflow.
|
|
6
24
|
|
|
7
25
|
## Documentation
|
|
8
26
|
|
|
9
|
-
|
|
27
|
+
See the [documentation](https://typedoc-plugin-markdown.org/plugins/docusaurus) for installation, configuration options, and usage guides.
|
|
10
28
|
|
|
11
29
|
## License
|
|
12
30
|
|
|
13
|
-
MIT
|
|
31
|
+
MIT
|
package/dist/plugin.js
CHANGED
|
@@ -12,6 +12,7 @@ export default async function pluginDocusaurus(context, opts) {
|
|
|
12
12
|
context.siteConfig?.plugins?.forEach((pluginConfig) => {
|
|
13
13
|
// Check PluginConfig is typed to ['docusaurus-plugin-typedoc', PluginOptions]
|
|
14
14
|
if (pluginConfig &&
|
|
15
|
+
typeof pluginConfig[0] === 'string' &&
|
|
15
16
|
pluginConfig[0].includes('docusaurus-plugin-typedoc') &&
|
|
16
17
|
typeof pluginConfig[1] === 'object') {
|
|
17
18
|
generateTypedoc(context, pluginConfig[1]);
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "docusaurus-plugin-typedoc",
|
|
3
|
-
"version": "1.4.
|
|
4
|
-
"description": "
|
|
3
|
+
"version": "1.4.3",
|
|
4
|
+
"description": "Runs TypeDoc inside the Docusaurus lifecycle.",
|
|
5
5
|
"exports": {
|
|
6
6
|
".": "./dist/index.js"
|
|
7
7
|
},
|
|
@@ -17,31 +17,34 @@
|
|
|
17
17
|
"url": "git+https://github.com/typedoc2md/typedoc-plugin-markdown.git",
|
|
18
18
|
"directory": "packages/docusaurus-plugin-typedoc"
|
|
19
19
|
},
|
|
20
|
-
"homepage": "
|
|
20
|
+
"homepage": "https://typedoc-plugin-markdown.org/plugins/docusaurus",
|
|
21
21
|
"scripts": {
|
|
22
22
|
"lint": "eslint ./src",
|
|
23
23
|
"prebuild": "rm -rf dist && copyfiles --up 1 ./src/**/*.cjs ./dist/",
|
|
24
24
|
"prepublishOnly": "npm run lint && npm run build",
|
|
25
25
|
"build": "tsc",
|
|
26
|
-
"pretest": "rm -rf ./test/out && docusaurus generate-typedoc",
|
|
26
|
+
"pretest": "rm -rf ./test/out && NO_UPDATE_NOTIFIER=1 docusaurus generate-typedoc",
|
|
27
27
|
"test": "mocha --config ./mocha.config.json",
|
|
28
28
|
"build-and-test": "npm run build && npm test"
|
|
29
29
|
},
|
|
30
30
|
"author": "Thomas Grey",
|
|
31
31
|
"license": "MIT",
|
|
32
32
|
"peerDependencies": {
|
|
33
|
-
"typedoc
|
|
33
|
+
"typedoc": "0.28.x",
|
|
34
|
+
"typedoc-plugin-markdown": ">=4.11.0"
|
|
34
35
|
},
|
|
35
36
|
"dependencies": {
|
|
36
|
-
"typedoc-docusaurus-theme": "^1.4.
|
|
37
|
+
"typedoc-docusaurus-theme": "^1.4.3"
|
|
37
38
|
},
|
|
38
|
-
"
|
|
39
|
-
"
|
|
40
|
-
"@docusaurus/types": "^3.8.1"
|
|
39
|
+
"engines": {
|
|
40
|
+
"node": ">= 18"
|
|
41
41
|
},
|
|
42
42
|
"keywords": [
|
|
43
43
|
"docusaurus",
|
|
44
44
|
"typedoc",
|
|
45
45
|
"plugin"
|
|
46
|
-
]
|
|
46
|
+
],
|
|
47
|
+
"devDependencies": {
|
|
48
|
+
"@docusaurus/core": "3.8.1"
|
|
49
|
+
}
|
|
47
50
|
}
|