typedoc
typedoc copied to clipboard
Documentation generator for TypeScript projects.
Is it possible to add more static pages to the generated web? And possibly improve the aesthetics?
After successfully configuring my TypeScript projects to automatically generate the documentation sites with TypeDoc, and resulting sites like , I further pursued the idea and did the same for one...
Allows for the overriding of `mappings`, so that they can be overriden by child themes that extend `DefaultTheme`. This will resolve current issues such as https://github.com/TypeStrong/typedoc/issues/2111 with the creation of...
This PR adds extra informations about the entrypoint on declarations & projects. As a plugin author, I would use those informations to read some files relative to each entrypoint. I...
This PR aims to fix #2147. Not sur you want to merge it in the present state, has I did not update the templates. I looked at it though, and...
## Search Terms hierarchy, packages ## Problem In the case where a monorepo has a base class in one package, and child classes in another package, TypeDoc will not link...
## Search Terms anchor, examples, ids, headers ## Problem There is no possibility to give a link to a header from generated documentation. I would like to link examples in...
## Expected Behavior Interpreting the JSDoc documentation where it states > By default, if you do not add a JSDoc comment to a symbol, the symbol will inherit documentation from...
## Search terms Cloudflare pages ## Expected Behavior Visiting a link for a `function` works ## Actual Behavior Cloudflare pages reverts to the `/index.html` because `/functions` is used for Cloudflare-specific...
## Search Terms expand, imported, types ## Problem Code: https://github.com/deep-foundation/capacitor-device/blob/6d6eae584c3567c5e381fc8a68f733e157d1ab85/src/device-info.ts#L1 ```ts import { BatteryInfo, GetLanguageCodeResult, LanguageTag, DeviceInfo as DeviceGeneralInfo } from "@capacitor/device"; export type DeviceInfo = | DeviceGeneralInfo | BatteryInfo...
When using the `navigation` categorization settings, the added sidebar elements are collapsible, which is super convenient for scrolling through large namespaces. The corresponding sections in the main page body are...