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
+9-7Lines changed: 9 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,13 +15,15 @@ provides links to MDN docs _and_ relevant specifications embedded in the API doc
15
15
------------
16
16
17
17
If you are using TypeDoc to generate documentation there are several plugins available to link all TS built-in lib
18
-
symbols to the hosted TS Lib docs.
18
+
symbols to the hosted TS Lib docs. You can find the NPM package here: [@typhonjs-typedoc/ts-lib-docs](https://www.npmjs.com/package/@typhonjs-typedoc/ts-lib-docs)
19
19
20
-
Include the following in your `dependencies` in `package.json`:
20
+
Include the following in your `devDependencies` in `package.json`:
21
21
```json
22
22
{
23
-
"dependencies": {
24
-
"@typhonjs-typedoc/ts-lib-docs": "2023.7.10"
23
+
"devDependencies": {
24
+
"@typhonjs-typedoc/ts-lib-docs": "2023.7.10",
25
+
"@typhonjs-typedoc/typedoc-theme-dmt": "^0.1.0",
26
+
"typedoc": "^0.24.8"
25
27
}
26
28
}
27
29
```
@@ -47,12 +49,12 @@ the above example.
47
49
A brand new Typedoc theme [@typhonjs-typedoc/typedoc-theme-dmt](https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt) /
48
50
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
49
51
reduction in disk space utilized upwards of 90% for large documentation projects like this one along with an 80% speed
50
-
improvement when generating docs.
52
+
improvement when generating docs. The DMT theme is not necessary to link your TypeDoc doc generation.
51
53
52
54
------------
53
55
54
-
Please note that these API docs are presently hosted through Github pages while a permanent hosting location is found.
55
-
IE if this gets popular GH bandwidth concerns may come into play.
56
+
Please note that the TS Lib API docs are presently hosted through Github pages while a permanent hosting location is
57
+
found. IE if this gets popular GH bandwidth concerns may come into play.
56
58
57
59
You may open an issue at [ts-lib-docs](https://github.com/typhonjs-typedoc/ts-lib-docs) repository for discussion /
0 commit comments