typedoc
typedoc copied to clipboard
Documentation generator for TypeScript projects.
This issue is related to https://github.com/TypeStrong/typedoc/issues/2502 but applies to non-literal types. Sorting of union types is non-deterministic. ## Steps to reproduce the bug ``` export type Type1 = 'type1'; export...
## Search terms categories, groups, options ## Expected Behavior I'm trying to structure code with both groups and categories. However, it's not clear to me what has precedence when and...
## Search Terms hierarchy ## Problem Having to go to a separate page (`hierarchy.html`) to view the full hierarchy of a declaration is inconvenient, and frankly the fact that `hierarchy.html`...
## Search terms Failed to resolve, comment, link to ## Expected Behavior No warning or errors when running typedoc ## Actual Behavior I'm getting the following warnings: [warning] Failed to...
Hi, we recently moved to using typedoc for our project [PixiJS](https://github.com/pixijs/pixijs) and found a weird issue. ## Expected Behavior When placing an `@ignore` tag on our exports we expected all...
## Search Terms host symbol ## Problem External symbols appearing in the documentation can currently only have their URL customized in limited form. For instance, you're currently able to specify...
## Search Terms sort, sorting, sort order, prop, props, properties, method, methods, class, interface ## Problem It's common to define members of classes and interfaces with a rational order applied...
When only the type of a function, class, or variable is exported, type-doc should group the exported symbol appropriately under `type aliases` and or `interfaces`. However, the original grouping is...
## Search Terms group groupDescription category ## Problem I've recently started using @group and @category, which have helped me organise the docs a lot better. I arrange by group in...