You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+59Lines changed: 59 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,3 +14,62 @@ Feedback is welcome.
14
14
This project is available to sponsors only, through my Insiders program.
15
15
See Insiders [explanation](https://mkdocstrings.github.io/typescript/insiders/)
16
16
and [installation instructions](https://mkdocstrings.github.io/typescript/insiders/installation/).
17
+
18
+
## Usage
19
+
20
+
Add these [TypeDoc](https://typedoc.org/) configuration files to your repository:
21
+
22
+
```tree hl_lines="4 5"
23
+
./
24
+
src/
25
+
package1/
26
+
typedoc.base.json
27
+
typedoc.json
28
+
```
29
+
30
+
```json title="typedoc.base.json"
31
+
{
32
+
"$schema": "https://typedoc.org/schema.json",
33
+
"includeVersion": true
34
+
}
35
+
```
36
+
37
+
```json title="typedoc.json"
38
+
{
39
+
"extends": ["./typedoc.base.json"],
40
+
"entryPointStrategy": "packages",
41
+
"entryPoints": ["./src/*"]
42
+
}
43
+
```
44
+
45
+
Update the entrypoints to match your file layout so that TypeDoc can find your packages. See [TypeDoc's configuration documentation](https://typedoc.org/options/configuration/).
46
+
47
+
Then in each of your package, add this TypeDoc configuration file:
48
+
49
+
```tree hl_lines="4"
50
+
./
51
+
src/
52
+
package1/
53
+
typedoc.json
54
+
typedoc.base.json
55
+
typedoc.json
56
+
```
57
+
58
+
```json title="typedoc.json"
59
+
{
60
+
"extends": ["../../typedoc.base.json"],
61
+
"entryPointStrategy": "expand",
62
+
"entryPoints": ["src/index.d.ts"]
63
+
}
64
+
```
65
+
66
+
Again, update entrypoints to match your file and package layout. See [TypeDoc's configuration documentation](https://typedoc.org/options/configuration/).
67
+
68
+
**Your packages must be built for TypeDoc to work.**
69
+
70
+
You are now able to use the TypeScript handler to inject API docs in your Markdown pages by referencing package names:
0 commit comments