{"repo":"TypeStrong/typedoc","free":true,"listed":false,"github":"https://github.com/TypeStrong/typedoc","clone":"git clone https://github.com/TypeStrong/typedoc.git","description":"Documentation generator for TypeScript projects.","language":"TypeScript","stars":8442,"topics":["typescript","documentation","generator"],"license":"Apache-2.0","category":"docs-static-sites","readme_excerpt":"TypeDoc Documentation generator for TypeScript projects. Documentation For more detailed documentation, the changelog, and TypeDoc documentation rendered with TypeDoc, see https://typedoc.org. Installation TypeDoc runs on Node.js and is available as a NPM package. Usage 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 and figure out your entry points from package.json , so you can probably run TypeDoc without any options: If TypeDoc does not automatically choose the entry points you wanted, you can specify them manually: 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. Monorepos / Workspaces 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 Options TypeDoc can be configured with command line arguments or a configuration file. Visit TypeDoc's site for a list of available options. Some commonly used options are: - --out Specifies the location the documentation should be written to. Defaults to .","default_branch":null,"files":null,"tree":[],"storefront":"/r/TypeStrong","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/TypeStrong/typedoc/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}