0.1.2 • Published 28 days ago
@apitree.cz/typedoc-config v0.1.2
TypeDoc Config
TypeDoc configuration for ApiTree projects
Installation
pnpm add --save-dev @apitree.cz/typedoc-config typedoc typescript
Usage
Add the following configuration to your typedoc.config.js
:
export { config as default } from '@apitree.cz/typedoc-config';
Then, run pnpm typedoc
to generate the documentation.
Custom Entry Points
The default configuration picks ./src/index.ts
in your package as the documentation entry point, however, you can
change this by overriding the entryPoints
property in your typedoc.config.js
:
import { config } from '@apitree.cz/typedoc-config';
export default {
...config,
entryPoints: ['./src/module-a/index.ts', './src/module-b/index.ts'],
};
See Options documentation for config reference.
0.1.2
28 days ago
0.1.1
5 months ago
0.1.0
6 months ago
0.1.0-next.41e8369
6 months ago
0.1.0-next.b32cc41
6 months ago
0.1.0-next.8925d8a
6 months ago
0.0.0
6 months ago