Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/typestrong/typedoc
Documentation generator for TypeScript projects.
https://github.com/typestrong/typedoc
documentation generator typescript
Last synced: 7 days ago
JSON representation
Documentation generator for TypeScript projects.
- Host: GitHub
- URL: https://github.com/typestrong/typedoc
- Owner: TypeStrong
- License: apache-2.0
- Created: 2014-05-24T14:40:16.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2024-12-09T02:07:38.000Z (14 days ago)
- Last Synced: 2024-12-10T22:37:06.274Z (12 days ago)
- Topics: documentation, generator, typescript
- Language: TypeScript
- Homepage: https://typedoc.org
- Size: 15.4 MB
- Stars: 7,807
- Watchers: 74
- Forks: 705
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# 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.
```text
npm install typedoc --save-dev
```
## 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, so you can
just specify the entry point of your library:
```text
typedoc src/index.ts
```
If you have multiple entry points, specify each of them.
```text
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.
### 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
### Arguments
For a complete list of the command line arguments run `typedoc --help` or visit
[our website](https://typedoc.org/options/).
- `--out `
Specifies the location the documentation should be written to. Defaults to `./docs`
- `--json `
Specifies the location and file name a json file describing the project is
written to. When specified no documentation will be generated unless `--out` is also
specified.
- `--options`
Specify a json option file that should be loaded. If not specified TypeDoc
will look for 'typedoc.json' in the current directory.
- `--tsconfig `
Specify a typescript config file that should be loaded. If not
specified TypeDoc will look for 'tsconfig.json' in the current directory.
- `--exclude `
Exclude files by the given pattern when a path is provided as source.
Supports standard minimatch patterns.
#### Theming
- `--theme `
Specify the theme that should be used.
- `--name `
Set the name of the project that will be used in the header of the template.
- `--readme `
Path to the readme file that should be displayed on the index page. Pass `none` to disable the index page
and start the documentation on the globals page.
#### Miscellaneous
- `--version`
Display the version number of TypeDoc.
- `--help`
Display all TypeDoc options.
## Contributing
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](https://github.com/TypeStrong/typedoc/blob/master/.github/CONTRIBUTING.md).