@apitree.cz/typedoc-config 0.0.0 → 0.1.0-next.41e8369
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 +3 -1
- package/package.json +3 -2
package/README.md
CHANGED
|
@@ -13,7 +13,7 @@
|
|
|
13
13
|
## Installation
|
|
14
14
|
|
|
15
15
|
```bash
|
|
16
|
-
pnpm add --save-dev @apitree.cz/typedoc-config typescript
|
|
16
|
+
pnpm add --save-dev @apitree.cz/typedoc-config typedoc typescript
|
|
17
17
|
```
|
|
18
18
|
|
|
19
19
|
## Usage
|
|
@@ -24,6 +24,8 @@ Add the following configuration to your `typedoc.config.js`:
|
|
|
24
24
|
export { config as default } from '@apitree.cz/typedoc-config';
|
|
25
25
|
```
|
|
26
26
|
|
|
27
|
+
Then, run `pnpm typedoc` to generate the documentation.
|
|
28
|
+
|
|
27
29
|
### Custom Entry Points
|
|
28
30
|
|
|
29
31
|
The default configuration picks `./src/index.ts` in your package as the documentation entry point, however, you can
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@apitree.cz/typedoc-config",
|
|
3
|
-
"version": "0.0.
|
|
3
|
+
"version": "0.1.0-next.41e8369",
|
|
4
4
|
"description": "TypeDoc configuration for ApiTree projects.",
|
|
5
5
|
"repository": {
|
|
6
6
|
"type": "git",
|
|
@@ -14,13 +14,14 @@
|
|
|
14
14
|
"dist"
|
|
15
15
|
],
|
|
16
16
|
"dependencies": {
|
|
17
|
-
"typedoc": "^0.25.3",
|
|
18
17
|
"typedoc-plugin-markdown": "^3.16.0"
|
|
19
18
|
},
|
|
20
19
|
"devDependencies": {
|
|
20
|
+
"typedoc": "^0.25.3",
|
|
21
21
|
"typescript": "^5.2.2"
|
|
22
22
|
},
|
|
23
23
|
"peerDependencies": {
|
|
24
|
+
"typedoc": "^0.25.3",
|
|
24
25
|
"typescript": "^5.2.2"
|
|
25
26
|
},
|
|
26
27
|
"scripts": {
|