![Introducing Enhanced Alert Actions and Triage Functionality](https://cdn.sanity.io/images/cgdhsj6q/production/fe71306d515f85de6139b46745ea7180362324f0-2530x946.png?w=800&fit=max&auto=format)
Product
Introducing Enhanced Alert Actions and Triage Functionality
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
typedoc
Advanced tools
Package description
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 src
Customizing 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 minimal
Excluding 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 --excludePrivate
Including 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 --includeDeclarations
JSDoc 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.js is a documentation generator that uses JSDoc-style comments to produce documentation for JavaScript code. It aims to be a community-driven, comprehensive documentation tool. Like JSDoc, it is not specifically designed for TypeScript and may not handle TypeScript features as seamlessly as TypeDoc.
Changelog
v0.26.0 (2024-06-22)
marked
to markdown-it
for parsing as marked has moved to an async model which supporting would significantly complicate TypeDoc's rendering code.
This means that any projects setting markedOptions
needs to be updated to use markdownItOptions
.
Unlike marked@4
, markdown-it
pushes lots of functionality to plugins. To use plugins, a JavaScript config file must be used with the markdownItLoader
option.--highlightLanguages
option.--excludePrivate
to true
.--sitemapBaseUrl
to --hostedBaseUrl
to reflect that it can be used for more than just the sitemap.navigation.fullTree
option.--media
option, TypeDoc will now detect image links within your comments and markdown documents and automatically copy them to the site.--includes
option, use the @document
tag instead.--stripYamlFrontmatter
option, TypeDoc will always do this now.--htmlLang
option to --lang
.--gaId
option for Google Analytics integration and corresponding analytics
theme member, #2600.Converter.EVENT_CREATE_DECLARATION
was emitted for ProjectReflection
in some circumstances.MapOptionDeclaration.mapError
has been removed.BindOption
decorator has been removed.DeclarationReflection.indexSignature
has been renamed to DeclarationReflection.indexSignatures
.
Note: This also affects JSON serialization. TypeDoc will support JSON output from 0.25 through at least 0.26.JSONOutput.SignatureReflection.typeParameter
has been renamed to typeParameters
to match the JS API.DefaultThemeRenderContext.iconsCache
has been removed as it is no longer needed.DefaultThemeRenderContext.hook
must now be passed context
if required by the hook.--projectDocuments
option to specify additional Markdown documents to be included in the generated site #247, #1870, #2288, #2565.packageOptions
object which specifies options that should be applied to each entry point when running with --entryPointStrategy packages
, #2523.--hostedBaseUrl
will now be used to generate a <link rel="canonical">
element in the project root page, #2550.--customFooterHtml
to add custom HTML to the generated page footer, #2559.--cascadedModifierTags
option, #2056.@alpha
and @beta
), #2056.@hideconstructor
tag.
This tag should only be used to work around TypeScript#58653, prefer the more general @hidden
/@ignore
tag to hide members normally, #2577.--useHostedBaseUrlForAbsoluteLinks
option to use the --hostedBaseUrl
option to produce absolute links to pages on a site, #940.--blockTags
option.documents-first
, documents-last
, and alphabetical-ignoring-documents
to order markdown documents.--alwaysCreateEntryPointModule
option. When set, TypeDoc will always create a Module
for entry points, even if only one is provided.
If --projectDocuments
is used to add documents, this option defaults to true
, otherwise, defaults to false
.--highlightLanguages
option to control what Shiki language packages are loaded.comment.beforeTags
and comment.afterTags
hooks for plugin use.
Combined with CommentTag.skipRendering
this can be used to provide custom tag handling at render time.Returns
header are now properly colored, #2546.navigationLinks
option are now moved into the pull out navigation on mobile displays, #2548.@license
and @import
comments will be ignored at the top of files, #2552.charset
is now correctly cased in <meta>
tag generated by the default theme, #2568.<head>
element could result in broken icons, #2589.@default
and @defaultValue
blocks are now recognized as regular blocks if they include inline tags, #2601.localStorage
.--hideParameterTypesInTitle
option no longer applies when rendering function types.@link
tags in readme files will now cause a warning when link validation is enabled.externalSymbolLinkMappings
option's support for meanings in declaration references.type=button
attribute set to avoid being treated as submit buttons.--hostedBaseUrl
will now implicitly add a trailing slash to the generated URL.Readme
Documentation generator for TypeScript projects.
For more detailed documentation, the changelog, 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.
typedoc package1/index.ts package2/index.ts
If you specify a directory, TypeDoc will use the entryPointStrategy
option to determine how to resolve it.
By default, TypeDoc will search for a file called index
under the directory.
If your codebase is comprised of one or more npm packages, you can build documentation for each of them individually
and merge the results together into a single site by setting entryPointStrategy
to packages
. In this mode TypeDoc
requires configuration to be present in each directory to specify the entry points. For an example setup, see
https://github.com/Gerrit0/typedoc-packages-example
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>
--out
is also
specified.--options
--tsconfig <path/to/tsconfig.json>
--exclude <pattern>
--theme <default|plugin defined theme>
--name <Documentation title>
--readme <path/to/readme|none>
none
to disable the index page
and start the documentation on the globals page.--version
--help
This 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.
FAQs
Create api documentation for TypeScript projects.
The npm package typedoc receives a total of 1,122,684 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.
Product
Socket now supports four distinct alert actions instead of the previous two, and alert triaging allows users to override the actions taken for all individual alerts.
Security News
Polyfill.io has been serving malware for months via its CDN, after the project's open source maintainer sold the service to a company based in China.
Security News
OpenSSF is warning open source maintainers to stay vigilant against reputation farming on GitHub, where users artificially inflate their status by manipulating interactions on closed issues and PRs.