Options
These options should be used in conjunction with the core TypeDoc options (see TypeDoc Usage).
File Options
Options that are used to configure how files are output.
- —outputFileStrategy
- —membersWithOwnFile
- —flattenOutputFiles
- —fileExtension
- —entryFileName
- —modulesFileName
- —entryModule
- —excludeScopesInPaths
- —mergeReadme
Display Options
Options that are used to configure how the output is structured and displayed.
- —hidePageHeader
- —hideBreadcrumbs
- —hidePageTitle
- —hideGroupHeadings
- —useCodeBlocks
- —expandObjects
- —expandParameters
- —blockTagsPreserveOrder
- —indexFormat
- —parametersFormat
- —interfacePropertiesFormat
- —classPropertiesFormat
- —enumMembersFormat
- —typeDeclarationFormat
- —propertyMembersFormat
- —tableColumnSettings
Utility Options
Options that are used for general configuration and utility purposes.