Skip to content

Commit c28e682

Browse files
committed
Update README
1 parent e694196 commit c28e682

File tree

1 file changed

+9
-7
lines changed

1 file changed

+9
-7
lines changed

README.md

Lines changed: 9 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -15,13 +15,15 @@ provides links to MDN docs _and_ relevant specifications embedded in the API doc
1515
------------
1616

1717
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)
1919

20-
Include the following in your `dependencies` in `package.json`:
20+
Include the following in your `devDependencies` in `package.json`:
2121
```json
2222
{
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"
2527
}
2628
}
2729
```
@@ -47,12 +49,12 @@ the above example.
4749
A brand new Typedoc theme [@typhonjs-typedoc/typedoc-theme-dmt](https://www.npmjs.com/package/@typhonjs-typedoc/typedoc-theme-dmt) /
4850
(Default Modern Theme) / theme augmentation is used to generate the TS Lib docs. The biggest feature is a massive
4951
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.
5153

5254
------------
5355

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.
5658

5759
You may open an issue at [ts-lib-docs](https://github.com/typhonjs-typedoc/ts-lib-docs) repository for discussion /
5860
feedback.

0 commit comments

Comments
 (0)