Describes the options declared by the plugin.
anchorPrefix:
string
Custom anchor prefix when anchoring to in-page symbols.
entryFileName:
string
The file name of the entry page.
entryModule:
string
The name of a module that should act as the root page for the documentation.
enumMembersFormat:
"table"|"list"
Specify the render style of enumeration members.
excludeGroups:
boolean
Excludes grouping by kind so all members are rendered and sorted at the same level.
excludeScopesInPaths:
boolean
Exclude writing @ scope directories in paths.
expandObjects:
boolean
Expand objects inside declarations.
expandParameters:
boolean
Expand parameters in signature parentheses to display type information.
fileExtension:
string
Specify the file extension for generated output files.
flattenOutputFiles:
boolean
Flatten output files to a single directory.
hideBreadcrumbs:
boolean
Do not print breadcrumbs.
hidePageHeader:
boolean
Do not print page header.
hidePageTitle:
boolean
Do not print page title.
indexFormat:
"table"|"list"
Specify the render format for index items.
membersWithOwnFile: (
"Enum"|"Variable"|"Function"|"Class"|"Interface"|"TypeAlias")[]
Determines which members are exported to their own file when outputFileStrategy equals members.
mergeReadme:
boolean
Merges the resolved readme into the project index page.
navigationModel:
object
Configures how the navigation model will be generated.
excludeGroups:
boolean
excludeCategories:
boolean
excludeFolders:
boolean
outputFileStrategy:
"members"|"modules"
Determines how output files are generated.
parametersFormat:
"table"|"list"
Specify the render style of parameter and type parameter groups.
preserveAnchorCasing:
boolean
Preserve anchor casing when generating link to symbols.
propertiesFormat:
"table"|"list"
Specify the render style of property groups for interfaces and classes.
publicPath:
string
Specify the base path for all urls.
sanitizeComments:
boolean
Sanitize HTML and JSX inside JsDoc comments.
textContentMappings:
Partial<TextContentMappings>
Provides a mechanism to change the content of text used in documentation.
typeDeclarationFormat:
"table"|"list"
Specify the render style for type declaration members.
useCodeBlocks:
boolean
Wraps signatures and declarations in code blocks.
useHTMLAnchors:
boolean
Add HTML named anchors to headings and table rows.