TypeDoc is a documentation generator for TypeScript projects. It reads your TypeScript source code and its comments and produces an HTML documentation website. It is capable of creating readable and user-friendly documentation for TypeScript projects, which can be very helpful for both maintaining internal code and for sharing code with external users.
Generating Documentation
This command generates documentation for the TypeScript source files located in the 'src' directory and outputs the result to the 'docs' directory.
typedoc --out docs srcCustomizing the Theme
This command generates documentation with a minimal theme, which is one of the built-in themes provided by TypeDoc.
typedoc --out docs src --theme minimalExcluding Private Members
This command generates documentation while excluding private members from the output, making the documentation cleaner if private members are not intended to be part of the public API.
typedoc --out docs src --excludePrivateIncluding Declaration Files
This command includes type declaration files (d.ts files) in the documentation generation process, which can be useful for documenting the types that are part of the project's external API.
typedoc --out docs src --includeDeclarationsJSDoc is a popular documentation generator for JavaScript. It uses comments in the source code to generate comprehensive documentation. While similar in purpose to TypeDoc, JSDoc is tailored for JavaScript and requires additional plugins to work well with TypeScript.
ESDoc is another documentation generator for JavaScript, with support for ES6+ syntax. It provides features like coverage reporting and integrated test codes in the documentation. ESDoc is not as TypeScript-focused as TypeDoc and may require additional configuration for TypeScript projects.
Documentation generator for TypeScript projects.
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 called from anywhere
if you install TypeDoc as a global module. The name of the executable is typedoc.
$ npm install typedoc --global
$ typedoc
TypeDoc accepts most of the command line arguments that the TypeScript compiler accepts. One major difference is the fact that one may pass an entire directory instead of individual files to the documentation generator. So in order to create a documentation for an entire project you simply type:
$ typedoc --out path/to/documentation/ path/to/typescript/project/
Starting with version 0.2, TypeDoc no longer can predict whether files should be treated as modules
or whether the project should be compiled into one big namespace. You must specify the mode argument
in order to change the behaviour of TypeDoc.
For a complete list of the command line arguments run typedoc --help or read here.
--out <path/to/documentation/>--mode <file|modules>--options--json <path/to/output.json>--ignoreCompilerErrors--exclude <pattern>--includeDeclarations--externalPattern <pattern>--excludeExternals--excludeNotExported--excludePrivate--excludeProtected--module <commonjs, amd, system or umd>--target <ES3, ES5, or ES6>--tsconfig <path/to/tsconfig.json>--theme <default|minimal|path/to/theme>--name <Documentation title>--readme <path/to/readme|none>none to disable the index page
and start the documentation on the globals page.--plugin--hideGenerator--gaID--gaSite <site>auto--entryPoint <fully.qualified.name>--gitRevision <revision|branch>--toc EntryClass,ImportantInterface--includes <path/to/includes>
Specifies the location to look for included documents. One may use [[include:FILENAME]]
in comments to include documents from this location.
--media <path/to/media>
Specifies the location with media files that should be copied to the output directory. In order to create
a link to media files use the pattern media://FILENAME in comments.
--version--helpThere is a plugin available to run TypeDoc with Webpack created by Microsoft. You can find it on NPM:
https://www.npmjs.com/package/typedoc-webpack-plugin
There is a plugin available to run TypeDoc with Gulp created by Rogier Schouten. You can find it on NPM:
https://www.npmjs.com/package/gulp-typedoc/
There is a plugin available to run TypeDoc with Grunt created by Bart van der Schoor. You can find it on NPM:
https://www.npmjs.com/package/grunt-typedoc
@internal or @external@tags as single linesA list of all published Typedoc plugins can be found on NPM:
https://www.npmjs.com/search?q=keywords:typedocplugin
Visit our homepage for advanced guides and an extensive API documentation:
https://typedoc.org
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.
Copyright (c) 2015 Sebastian Lenz.
Copyright (c) 2016-2018 TypeDoc Contributors.
Licensed under the Apache License 2.0.
FAQs
Create api documentation for TypeScript projects.
The npm package typedoc receives a total of 1,414,075 weekly downloads. As such, typedoc popularity was classified as popular.
We found that typedoc demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
Security News
A threat actor's playbook for exploiting the npm ecosystem was exposed on the dark web, detailing how to build a blockchain-powered botnet.
Security News
NVD’s backlog surpasses 20,000 CVEs as analysis slows and NIST announces new system updates to address ongoing delays.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.