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.
For more detailed documentation, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org.
TypeDoc runs on Node.js and is available as a NPM package.
npm install typedoc --save-dev
To generate documentation TypeDoc needs to know your project entry point, and TypeScript
compiler options. It will automatically try to find your tsconfig.json file, so you can
just specify the entry point of your library:
typedoc src/index.ts
If you have multiple entry points, specify each of them. If you specify a directory, TypeDoc will treat each file contained within it as an entry point.
typedoc package1/index.ts package2/index.ts
For a complete list of the command line arguments run typedoc --help or visit
our website.
--out <path/to/documentation/>./docs--json <path/to/output.json>--options--tsconfig <path/to/tsconfig.json>--exclude <pattern>--excludeNotDocumented--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.--listInvalidSymbolLinks--version--helpThis project is maintained by a community of developers. Contributions are welcome and appreciated. You can find TypeDoc on GitHub; feel free to open an issue or create a pull request: https://github.com/TypeStrong/typedoc
For more information, read the contribution guide.
Copyright (c) 2015 Sebastian Lenz.
Copyright (c) 2016-2020 TypeDoc Contributors.
Licensed under the Apache License 2.0.
v0.20.32 (2021-03-14)
FAQs
Create api documentation for TypeScript projects.
The npm package typedoc receives a total of 745,163 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 0 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.
Security News
A new Rust RFC proposes "Trusted Publishing" for Crates.io, introducing short-lived access tokens via OIDC to improve security and reduce risks associated with long-lived API tokens.
Security News
Cloudflare is expanding Node.js compatibility for Workers and Pages, enabling developers to use more npm packages through a hybrid approach that combines native code and polyfills for Node.js APIs.
Security News
The Python Software Foundation has expanded its CNA scope to include the Pallets Projects, enabling faster, more reliable CVE tracking for critical frameworks used in Python applications.