@powerlines/plugin-typedoc 0.10.685 → 0.10.687
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 +39 -0
- package/package.json +5 -5
package/README.md
CHANGED
|
@@ -74,6 +74,45 @@ A package containing a Powerlines plugin that integrates TypeDoc into the Powerl
|
|
|
74
74
|
|
|
75
75
|
<!-- END doctoc -->
|
|
76
76
|
|
|
77
|
+
## Features
|
|
78
|
+
|
|
79
|
+
- Generates API documentation with [TypeDoc](https://typedoc.org/)
|
|
80
|
+
- Writes output to `docs/generated/api-reference` by default
|
|
81
|
+
- Supports a custom `outputPath` and `basePath`
|
|
82
|
+
- Resolves output settings through the `configResolved` hook
|
|
83
|
+
|
|
84
|
+
## Usage
|
|
85
|
+
|
|
86
|
+
Install the plugin:
|
|
87
|
+
|
|
88
|
+
```bash
|
|
89
|
+
pnpm add @powerlines/plugin-typedoc
|
|
90
|
+
```
|
|
91
|
+
|
|
92
|
+
Register it in `powerlines.config.ts`:
|
|
93
|
+
|
|
94
|
+
```ts
|
|
95
|
+
import { plugin as typedoc } from "@powerlines/plugin-typedoc";
|
|
96
|
+
import { defineConfig } from "powerlines/config";
|
|
97
|
+
|
|
98
|
+
export default defineConfig({
|
|
99
|
+
plugins: [typedoc()]
|
|
100
|
+
});
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
Generate documentation with the docs command. To change the output path:
|
|
104
|
+
|
|
105
|
+
```ts
|
|
106
|
+
export default defineConfig({
|
|
107
|
+
plugins: [
|
|
108
|
+
typedoc({
|
|
109
|
+
outputPath: "docs/api",
|
|
110
|
+
basePath: "/docs/"
|
|
111
|
+
})
|
|
112
|
+
]
|
|
113
|
+
});
|
|
114
|
+
```
|
|
115
|
+
|
|
77
116
|
## Installing
|
|
78
117
|
|
|
79
118
|
Using [pnpm](http://pnpm.io):
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@powerlines/plugin-typedoc",
|
|
3
|
-
"version": "0.10.
|
|
3
|
+
"version": "0.10.687",
|
|
4
4
|
"type": "module",
|
|
5
5
|
"description": "A package containing a Powerlines plugin for running TypeDoc on the codebase.",
|
|
6
6
|
"repository": {
|
|
@@ -86,21 +86,21 @@
|
|
|
86
86
|
"files": ["dist/**/*"],
|
|
87
87
|
"keywords": ["powerlines", "storm-software", "powerlines-plugin"],
|
|
88
88
|
"dependencies": {
|
|
89
|
-
"@storm-software/config-tools": "^1.190.
|
|
89
|
+
"@storm-software/config-tools": "^1.190.154",
|
|
90
90
|
"@stryke/fs": "^0.33.118",
|
|
91
91
|
"@stryke/path": "^0.29.43",
|
|
92
92
|
"defu": "^6.1.7",
|
|
93
|
-
"powerlines": "^0.47.
|
|
93
|
+
"powerlines": "^0.47.217",
|
|
94
94
|
"typedoc": "0.25.12",
|
|
95
95
|
"typedoc-plugin-markdown": "4.0.0-next.20"
|
|
96
96
|
},
|
|
97
97
|
"devDependencies": {
|
|
98
|
-
"@powerlines/plugin-plugin": "^0.12.
|
|
98
|
+
"@powerlines/plugin-plugin": "^0.12.630",
|
|
99
99
|
"@types/node": "^25.9.9"
|
|
100
100
|
},
|
|
101
101
|
"publishConfig": { "access": "public" },
|
|
102
102
|
"main": "./dist/index.cjs",
|
|
103
103
|
"module": "./dist/index.mjs",
|
|
104
104
|
"types": "./dist/index.d.cts",
|
|
105
|
-
"gitHead": "
|
|
105
|
+
"gitHead": "bb4e1f2b32a8bb9d20559ca7c3df3a2f30a0d14e"
|
|
106
106
|
}
|