typedoc
typedoc copied to clipboard
Documentation generator for TypeScript projects.
As documented in `.github/CONTRIBUTING.md#linting`, a user should be able to automatically fix linting errors with `npm run lint -- --fix` The --fix flag however causes: - [warn] Ignored unknown option...
This resolves [issue 2024](https://github.com/TypeStrong/typedoc/issues/2024). It: - allows default plugin options declared as 'mixed' type to be overridden partially by sub-key in typedoc.json
## Search terms options addDeclaration custom ## Expected Behavior When adding custom options with `app.options.addDeclaration`, the `defaultValue` fields will be overridden by values in `typedoc.json`, otherwise retained as per default....
## Search terms options theme custom ## Expected Behavior When adding custom theme using ```js app.renderer.defineTheme(`custom`, SomeCustomTheme); app.bootstrap({... , theme : "custom"}) ``` The final output should render according to...
## Search terms error The 'compilerOptions' option must be a non-array object. ## Expected Behavior Typedoc works as expected: ``` npx typedoc --compilerOptions '{ "skipLibCheck": true }' ``` ## Actual...
The current mechanism by which a `ReferenceType` figures out which package the type came from is by parsing the path and taking the first path element following `node_modules`. This breaks...
## Search Terms native ecmascript, esm, plugin ## Problem It would be nice to write TypeDoc plugins as ESM modules, using node's new native ESM support ## Suggested Solution typedoc...
## Search Terms constructor parameter property documentation ## Problem When using `--excludeNotDocumented`, a class that declares properties in the constructor the properties do not seem to be documented correctly even...
## Search terms * `TypeError: Cannot read properties of undefined (reading 'map')` * intersectionConverter * convertType * undefined map ## Expected Behavior Expected that typing `typedoc` from the CLI would...
I think I'll regret this in a week, so pushing to a branch for now...