typedoc
Create api documentation for TypeScript projects.
Last updated 4 years ago
by typedoc-bot
.
Apache-2.0
·
Repository
·
Bugs
·
Original npm
·
Tarball
·
package.json
$ npm install typedoc
SYNC missed versions from
official npm registry.
TypeDoc
Documentation generator for TypeScript projects.
Documentation
Visit our website for more complete documentation and example API documentation:
https://typedoc.org.
There you can find an installation guide explaining how to use typedoc from the cli, webpack, grunt, or gulp. There are additional guides explaining how to extend typedoc using plugins and themes.
Installation
TypeDoc runs on Node.js and is available as an NPM package. You can install TypeDoc in your project's directory as usual:
$ npm install typedoc --save-dev
Like the TypeScript compiler, TypeDoc comes with a binary that can be run with npx.
$ npx typedoc path/to/entry.ts
Usage
To run TypeDoc, pass it your library's entry point. TypeDoc will use the TypeScript compiler to determine what has been exported and document those items. If you specify a directory as an entry point, TypeDoc will treat all files and folders within that directory as entry points.
TypeDoc will try to discover your tsconfig.json file, but if it fails, you can specify the path
to it with --tsconfig.
$ typedoc --tsconfig path/to/tsconfig.json path/to/entry.ts
Common Arguments
For a complete list of the command line arguments run typedoc --help or visit our website.
--html <path/to/documentation/>
Specifies the location the documentation should be written to. Defaults to./docs--theme <default|minimal|path/to/theme>
Specify the path to the theme that should be used.--json <path/to/output.json>
Specifies the location and file name a json file describing the project is written to.
Contributing
This project is maintained by a community of developers. Contributions are welcome and appreciated.
You can find TypeDoc on GitHub; feel free to start an issue or create a pull requests:
https://github.com/TypeStrong/typedoc
For more information, read the contribution guide.
License
Copyright (c) 2015 Sebastian Lenz.
Copyright (c) 2016-2020 TypeDoc Contributors.
Licensed under the Apache License 2.0.
Current Tags
- 0.26.0-beta.5 ... beta (5 months ago)
- 0.26.8 ... latest (a month ago)
- 0.22.15 ... lts (3 years ago)
310 Versions
- 0.26.8 ... a month ago
- 0.26.7 ... 2 months ago
- 0.26.6 ... 3 months ago
- 0.26.5 ... 4 months ago
- 0.26.4 ... 4 months ago
- 0.26.3 ... 5 months ago
- 0.26.2 ... 5 months ago
- 0.26.1 ... 5 months ago
- 0.26.0 ... 5 months ago
- 0.26.0-beta.5 ... 5 months ago
- 0.26.0-beta.4 ... 5 months ago
- 0.26.0-beta.3 ... 5 months ago
- 0.26.0-beta.2 ... 5 months ago
- 0.26.0-beta.1 ... 6 months ago
- 0.26.0-beta.0 ... 6 months ago
- 0.25.13 ... 7 months ago
- 0.25.12 ... 8 months ago
- 0.25.11 ... 8 months ago
- 0.25.10 ... 8 months ago
- 0.25.9 ... 9 months ago
- 0.25.8 ... 9 months ago
- 0.25.7 ... 10 months ago
- 0.25.6 ... 10 months ago
- 0.25.5 ... 10 months ago
- 0.25.4 ... a year ago
- 0.25.3 ... a year ago
- 0.25.2 ... a year ago
- 0.25.1 ... a year ago
- 0.25.0 ... a year ago
- 0.24.8 ... a year ago
- 0.24.7 ... 2 years ago
- 0.24.6 ... 2 years ago
- 0.24.5 ... 2 years ago
- 0.24.4 ... 2 years ago
- 0.24.3 ... 2 years ago
- 0.24.2 ... 2 years ago
- 0.24.1 ... 2 years ago
- 0.24.0 ... 2 years ago
- 0.24.0-beta.8 ... 2 years ago
- 0.24.0-beta.7 ... 2 years ago
- 0.24.0-beta.6 ... 2 years ago
- 0.24.0-beta.5 ... 2 years ago
- 0.24.0-beta.4 ... 2 years ago
- 0.23.28 ... 2 years ago
- 0.23.27 ... 2 years ago
- 0.24.0-beta.3 ... 2 years ago
- 0.24.0-beta.2 ... 2 years ago
- 0.24.0-beta.1 ... 2 years ago
- 0.23.26 ... 2 years ago
- 0.23.25 ... 2 years ago
- 0.23.24 ... 2 years ago
- 0.23.23 ... 2 years ago
- 0.23.22 ... 2 years ago
- 0.23.21 ... 2 years ago
- 0.23.20 ... 2 years ago
- 0.23.19 ... 2 years ago
- 0.23.18 ... 2 years ago
- 0.23.17 ... 2 years ago
- 0.23.16 ... 2 years ago
- 0.23.15 ... 2 years ago
- 0.23.14 ... 2 years ago
- 0.23.13 ... 2 years ago
- 0.23.12 ... 2 years ago
- 0.23.11 ... 2 years ago
- 0.23.10 ... 2 years ago
- 0.23.9 ... 2 years ago
- 0.23.8 ... 2 years ago
- 0.23.7 ... 2 years ago
- 0.23.6 ... 2 years ago
- 0.23.5 ... 2 years ago
- 0.23.4 ... 2 years ago
- 0.23.3 ... 2 years ago
- 0.23.2 ... 2 years ago
- 0.23.1 ... 2 years ago
- 0.23.0 ... 2 years ago
- 0.23.0-beta.7 ... 2 years ago
- 0.23.0-beta.6 ... 2 years ago
- 0.22.18 ... 2 years ago
- 0.23.0-beta.5 ... 2 years ago
- 0.23.0-beta.4 ... 2 years ago
- 0.23.0-beta.3 ... 2 years ago
- 0.22.17 ... 2 years ago
- 0.23.0-beta.2 ... 2 years ago
- 0.22.16 ... 2 years ago
- 0.23.0-beta.1 ... 3 years ago
- 0.23.0-beta.0 ... 3 years ago
- 0.22.15 ... 3 years ago
- 0.22.14 ... 3 years ago
- 0.22.13 ... 3 years ago
- 0.22.12 ... 3 years ago
- 0.21.10 ... 3 years ago
- 0.22.11 ... 3 years ago
- 0.22.10 ... 3 years ago
- 0.22.9 ... 3 years ago
- 0.22.8 ... 3 years ago
- 0.22.7 ... 3 years ago
- 0.22.6 ... 3 years ago
- 0.22.5 ... 3 years ago
- 0.22.4 ... 3 years ago
- 0.22.3 ... 3 years ago
- 0.22.2 ... 3 years ago
- 0.22.1 ... 3 years ago
- 0.22.0 ... 3 years ago
- 0.22.0-beta.10 ... 3 years ago
- 0.22.0-beta.9 ... 3 years ago
- 0.22.0-beta.8 ... 3 years ago
- 0.22.0-beta.7 ... 3 years ago
- 0.22.0-beta.6 ... 3 years ago
- 0.21.9 ... 3 years ago
- 0.22.0-beta.5 ... 3 years ago
- 0.21.8 ... 3 years ago
- 0.21.7 ... 3 years ago
- 0.21.6 ... 3 years ago
- 0.22.0-beta.4 ... 3 years ago
- 0.22.0-beta.2 ... 3 years ago
- 0.22.0-beta.1 ... 3 years ago
- 0.22.0-beta.0 ... 3 years ago
- 0.21.5 ... 3 years ago
- 0.21.4 ... 3 years ago
- 0.21.3 ... 3 years ago
- 0.21.2 ... 3 years ago
- 0.21.1 ... 3 years ago
- 0.21.0 ... 3 years ago
- 0.20.37 ... 3 years ago
- 0.21.0-beta.4 ... 3 years ago
- 0.21.0-beta.3 ... 3 years ago
- 0.21.0-beta.2 ... 3 years ago
- 0.21.0-beta.1 ... 3 years ago
- 0.20.36 ... 4 years ago
- 0.20.35 ... 4 years ago
- 0.20.34 ... 4 years ago
- 0.20.33 ... 4 years ago
- 0.20.32 ... 4 years ago
- 0.20.31 ... 4 years ago
- 0.20.30 ... 4 years ago
- 0.20.29 ... 4 years ago
- 0.20.28 ... 4 years ago
- 0.20.27 ... 4 years ago
- 0.20.26 ... 4 years ago
- 0.20.25 ... 4 years ago
- 0.20.24 ... 4 years ago
- 0.20.23 ... 4 years ago
- 0.20.22 ... 4 years ago
- 0.20.21 ... 4 years ago
- 0.20.20 ... 4 years ago
- 0.20.19 ... 4 years ago
- 0.20.18 ... 4 years ago
- 0.20.17 ... 4 years ago
- 0.20.16 ... 4 years ago
- 0.20.15 ... 4 years ago
- 0.20.14 ... 4 years ago
- 0.20.13 ... 4 years ago
- 0.20.12 ... 4 years ago
- 0.20.11 ... 4 years ago
- 0.20.10 ... 4 years ago
- 0.20.9 ... 4 years ago
- 0.20.8 ... 4 years ago
- 0.20.7 ... 4 years ago
- 0.20.6 ... 4 years ago
- 0.20.5 ... 4 years ago
- 0.20.4 ... 4 years ago
- 0.20.3 ... 4 years ago
- 0.20.2 ... 4 years ago
- 0.20.1 ... 4 years ago
- 0.20.0 ... 4 years ago
- 0.20.0-beta.33 ... 4 years ago
- 0.20.0-beta.32 ... 4 years ago
- 0.20.0-beta.31 ... 4 years ago
- 0.20.0-beta.30 ... 4 years ago
- 0.20.0-beta.29 ... 4 years ago
- 0.20.0-beta.28 ... 4 years ago
- 0.20.0-beta.27 ... 4 years ago
- 0.20.0-beta.26 ... 4 years ago
- 0.20.0-beta.25 ... 4 years ago
- 0.20.0-beta.24 ... 4 years ago
- 0.20.0-beta.23 ... 4 years ago
- 0.20.0-beta.22 ... 4 years ago
- 0.20.0-beta.21 ... 4 years ago
- 0.20.0-beta.20 ... 4 years ago
- 0.20.0-beta.19 ... 4 years ago
- 0.20.0-beta.18 ... 4 years ago
- 0.20.0-beta.17 ... 4 years ago
- 0.20.0-beta.16 ... 4 years ago
- 0.20.0-beta.15 ... 4 years ago
- 0.20.0-beta.14 ... 4 years ago
- 0.20.0-beta.13 ... 4 years ago
- 0.20.0-beta.12 ... 4 years ago
- 0.20.0-beta.11 ... 4 years ago
- 0.20.0-beta.10 ... 4 years ago
- 0.20.0-beta.9 ... 4 years ago
- 0.20.0-beta.8 ... 4 years ago
- 0.20.0-beta.7 ... 4 years ago
- 0.20.0-beta.6 ... 4 years ago
- 0.20.0-beta.5 ... 4 years ago
- 0.20.0-beta.4 ... 4 years ago
- 0.20.0-beta.3 ... 4 years ago
- 0.20.0-beta.2 ... 4 years ago
- 0.20.0-beta.1 ... 4 years ago
- 1.0.0-dev.4 ... 4 years ago
- 0.19.2 ... 4 years ago
- 1.0.0-dev.3 ... 4 years ago
- 1.0.0-dev.2 ... 4 years ago
- 0.19.1 ... 4 years ago
- 1.0.0-dev.1 ... 4 years ago
- 0.19.0 ... 4 years ago
- 0.18.0 ... 4 years ago
- 0.17.8 ... 4 years ago
- 0.17.7 ... 4 years ago
- 0.17.6 ... 5 years ago
- 0.17.5 ... 5 years ago
- 0.17.4 ... 5 years ago
- 0.17.3 ... 5 years ago
- 0.17.2 ... 5 years ago
- 0.17.1 ... 5 years ago
- 0.17.0 ... 5 years ago
- 0.16.11 ... 5 years ago
- 0.16.10 ... 5 years ago
- 0.16.9 ... 5 years ago
- 0.17.0-3 ... 5 years ago
- 0.16.8 ... 5 years ago
- 0.17.0-2 ... 5 years ago
- 0.17.0-1 ... 5 years ago
- 0.17.0-0 ... 5 years ago
- 0.16.7 ... 5 years ago
- 0.16.6 ... 5 years ago
- 0.16.5 ... 5 years ago
- 0.16.4 ... 5 years ago
- 0.16.3 ... 5 years ago
- 0.16.2 ... 5 years ago
- 0.16.1 ... 5 years ago
- 0.16.0 ... 5 years ago
- 0.16.0-8 ... 5 years ago
- 0.16.0-7 ... 5 years ago
- 0.16.0-6 ... 5 years ago
- 0.16.0-5 ... 5 years ago
- 0.15.8 ... 5 years ago
- 0.16.0-4 ... 5 years ago
- 0.15.7 ... 5 years ago
- 0.16.0-3 ... 5 years ago
- 0.16.0-2 ... 5 years ago
- 0.16.0-1 ... 5 years ago
- 0.16.0-0 ... 5 years ago
- 0.15.6 ... 5 years ago
- 0.15.5 ... 5 years ago
- 0.15.4 ... 5 years ago
- 0.15.3 ... 5 years ago
- 0.15.2 ... 5 years ago
- 0.15.1 ... 5 years ago
- 0.15.0 ... 5 years ago
- 0.15.0-0 ... 6 years ago
- 0.14.2 ... 6 years ago
- 0.14.1 ... 6 years ago
- 0.14.0 ... 6 years ago
- 0.13.0 ... 6 years ago
- 0.13.0-0 ... 6 years ago
- 0.12.0 ... 6 years ago
- 0.11.1 ... 7 years ago
- 0.11.0 ... 7 years ago
- 0.10.0 ... 7 years ago
- 0.9.0 ... 7 years ago
- 0.8.0 ... 7 years ago
- 0.7.2 ... 7 years ago
- 0.7.1 ... 7 years ago
- 0.7.0 ... 8 years ago
- 0.6.0 ... 8 years ago
- 0.5.10 ... 8 years ago
- 0.5.9 ... 8 years ago
- 0.5.8 ... 8 years ago
- 0.5.7 ... 8 years ago
- 0.5.6 ... 8 years ago
- 0.5.5 ... 8 years ago
- 0.5.4 ... 8 years ago
- 0.5.3 ... 8 years ago
- 0.5.2 ... 8 years ago
- 0.5.1 ... 8 years ago
- 0.5.0 ... 8 years ago
- 0.4.5 ... 8 years ago
- 0.4.4 ... 8 years ago
- 0.4.3 ... 8 years ago
- 0.4.2 ... 8 years ago
- 0.4.1 ... 8 years ago
- 0.4.0 ... 8 years ago
- 0.3.12 ... 9 years ago
- 0.3.11 ... 9 years ago
- 0.3.10 ... 9 years ago
- 0.3.9 ... 9 years ago
- 0.3.8 ... 9 years ago
- 0.3.7 ... 9 years ago
- 0.3.6 ... 9 years ago
- 0.3.5 ... 9 years ago
- 0.3.4 ... 10 years ago
- 0.3.3 ... 10 years ago
- 0.3.2 ... 10 years ago
- 0.3.1 ... 10 years ago
- 0.3.0 ... 10 years ago
- 0.2.3 ... 10 years ago
- 0.2.2 ... 10 years ago
- 0.2.1 ... 10 years ago
- 0.2.0 ... 10 years ago
- 0.1.3 ... 10 years ago
- 0.1.2 ... 10 years ago
- 0.1.1 ... 10 years ago
- 0.1.0 ... 10 years ago
- 0.0.7 ... 10 years ago
- 0.0.6 ... 10 years ago
- 0.0.5 ... 10 years ago
- 0.0.4 ... 10 years ago
- 0.0.3 ... 10 years ago
- 0.0.2 ... 10 years ago
- 0.0.1 ... 10 years ago
Maintainers (5)
blakeembrey
sebastian-lenz
aciccarello
gerrit0
typedoc-bot
Downloads
Total
3
Today
0
This Week
0
This Month
0
Last Day
0
Last Week
0
Last Month
2
Dependencies (9)
- lunr ^2.3.9
- color ^3.1.2
- shiki ^0.2.2
- marked 1.1.1
- preact ^10.4.8
- shelljs ^0.8.4
- minimatch ^3.0.0
- @types/color ^3.0.1
- preact-render-to-string ^5.1.10
Dev Dependencies (13)
- nyc 15.1.0
- mocha ^8.1.3
- eslint ^7.7.0
- prettier 2.1.1
- typescript ^4.0.2
- @types/lunr ^2.3.3
- @types/node ^14.6.2
- @types/mocha ^8.0.3
- @types/marked ^1.1.0
- @types/shelljs ^0.8.8
- @types/minimatch 3.0.3
- @typescript-eslint/parser ^3.10.1
- @typescript-eslint/eslint-plugin ^3.10.1
Dependents (28)
- @bevry/update-contributors
- ambi
- arrangekeys
- assert-helpers
- badges
- caterpillar
- caterpillar-filter
- caterpillar-human
- editions
- fellow
- get-cli-arg
- get-current-line
- getcontributors
- getrepos
- getsetdeep
- githubauthreq
- ignorefs
- ignorepatterns
- istextorbinary
- midway-bin
- native-promise-pool
- normalify
- projectz
- rfc-log-levels
- rxjs
- sortobject
- typechecker
- valid-module