|
преди 4 години | |
---|---|---|
.. | ||
bin | преди 4 години | |
dist | преди 4 години | |
LICENSE | преди 4 години | |
README.md | преди 4 години | |
package.json | преди 4 години |
Documentation generator for TypeScript projects.
Visit our website for more complete documentation and example API documentation:
https://typedoc.org.
There you can find an installation guide explaining how to use typedoc from the cli, webpack, grunt, or gulp. There are additional guides explaining how to extend typedoc using plugins and themes.
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/
For a complete list of the command line arguments run typedoc --help
or visit our website.
--out <path/to/documentation/>
./docs
--mode <file|modules>
--options
--json <path/to/output.json>
--ignoreCompilerErrors
--exclude <pattern>
--includeDeclarations
--excludeExternals
--includeDeclarations
.--excludeNotDocumented
--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.--listInvalidSymbolLinks
--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 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-2020 TypeDoc Contributors.
Licensed under the Apache License 2.0.