TypeDoc 符号解析器
Resolves TypeScript symbols and generates API documentation using the TypeDoc compiler API and ts-morph for AST manipulation. Creates interlinked reference pages with declaration merging support and module augmentation tracking.
Installation
Use the upstream install or setup path that matches your environment:
- npm install typedoc --save-dev
Requirements and caveats from upstream:
- TypeDoc runs on Node.js and is available as a NPM package.
- requires configuration to be present in each directory to specify the entry points. For an example setup, see
Basic usage or getting-started notes:
- text
- 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
- Source: https://github.com/1991513ccie-png/skills
- Extracted from upstream docs: https://raw.githubusercontent.com/TypeStrong/typedoc/HEAD/README.md
Documentation
- https://typedoc.org/
