Enter options
| name | illustrate |
|---|---|
| entryPoints | This option is used to specify the entry point for documentation generated by Typedoc. The entry point refers to the file or module in which the definition of the documented object is located. By specifying the entry point, Typedoc can find the documented object and generate the corresponding documentation. This option accepts a string or array of strings specifying the path to one or more entry files. |
| entryPointStrategy | Specifies a strategy for handling entry points, which are files or modules in which the definition of the documented object resides. TypeDoc does this by checking the exports of these files and creating documentation based on those exports. |
| exclude | Used to specify files or folders that should be excluded from the compilation process. This means that when Typedoc processes TypeScript source code, it will ignore these specified files or folders and will not include them in the generated documentation. |
| externalPattern | Used to specify a regular expression pattern used to identify external modules. By default, it treats all imported modules in the project as internal modules and generates corresponding documentation. However, some modules may be imported from outside and do not need to generate documentation. At this time, you can use the externalPattern option to specify which modules should be considered external modules and not included in the generated documentation. |
| excludeExternals | Used to specify whether to exclude external modules, the excludeExternals option can be set to true or false |
| excludeNotDocumented | The excludeNotDocumented option can be set to true or false. If set to true, Typedoc will only log symbols with documentation comments and ignore other uncommented symbols. If set to false or this option is not set, Typedoc will log all resolved symbols, including uncommented symbols. |
| excludeInternal | Used to specify whether to exclude internal modules, the excludeInternal option can be set to true or false. If set to true, Typedoc will exclude all internal modules and only generate documentation for publicly accessible modules. If set to false or this option is not set, Typedoc will include all exportable modules in the generated documentation. |
| excludePrivate | Used to specify whether to exclude private members, the excludePrivate option can be set to true or false. If set to true, Typedoc will exclude all private members and only generate documentation for non-private members. If set to false or this option is not set, Typedoc will include all parsed members in the generated document. |
| excludeProtected | Used to specify whether to exclude protected members, the excludeProtected option can be set to true or false. If set to true, Typedoc will exclude all protected members and only generate documentation for non-protected members. If set to false or this option is not set, Typedoc will include all parsed members in the generated document |
| media | Inject multimedia file address |
| includes | When Typedoc generates a document, it looks for the specified files or folders and includes them in the generated document, injecting other document addresses, such as markdown files |
Output options
| name | illustrate |
|---|---|
| out | Document output directory |
| json | Typedoc can generate a JSON file that contains comments and metadata from TypeScript source code, as well as documentation information associated with them. This JSON file can be read and used by other tools for further processing and presentation of the document |
| pretty | Used to specify whether to add formatting and beautification to the generated document |
| emit | When set to true, the "emit" option will cause Typedoc to generate documentation and output it to the specified output format (such as HTML, JSON, etc.). If set to false, Typedoc will not generate any output files but will still perform the document parsing and generation process. |
| theme | default,minimal,path |
| customCss | Supports customizing the appearance and style of the document through CSS. In TypeDoc, you can use custom CSS files to override the default styles and customize them to your needs |
| markedOptions | Used to specify options passed to the Marked library. The Marked library is a JavaScript library for converting Markdown text to HTML, used by TypeDoc to parse comments into HTML documents. |
| name | name |
| includeVersion | Whether to include version number |
| disableSources | Used to specify whether to disable the generation of source map (source map) |
| basePath | Specifies the base path used to display file paths. If not set, TypeDoc will guess by taking the lowest common directory of all source files. |
| excludeTags | Specifies tags that should be removed from documentation comments when parsing them. This feature is useful if your project uses apiDoc to document RESTful Web APIs. |
| readme | readme text path or None |
| cname | Create a CNAME file in the specified output directory and fill in the specified text |
| htmlOnly | Set the lang attribute in the HTML output of TypeDoc. The default is en, and the result is <html lang="en">. |
| hideGenerator | Do not print the TypeDoc link at the end of the page. Default is false. |
| searchInComments | Enables the ability to search annotation text in the generated documentation site. NOTE: Enabling this option will increase the size of your search index, possibly by an order of magnitude on projects with many long comments |
Annotation options
| name | illustrate |
|---|---|
| commentStyle | Determines the annotation type TypeDoc will use. |
| blockTags | Overrides TypeDoc's support block tags, warning about any tags not listed here. |
Organization options
| name | illustrate |
|---|---|
| categorizeByGroup | This flag classifies reflection by group (within properties, methods, etc.). To group properties and methods of the same category together, set this flag to false. Default is true. |
| defaultCategory | Sets a name for the default category that is used when certain elements on the page are categorized. Default value is "Other" |
| categoryOrder | This array option allows overriding the order in which categories appear in . A string consisting of * indicating where a category not in the list should appear. By default, categories appear in alphabetical order. If unknown categories are found, they will be listed last by default. |
| sort | Show sort |
common arrangement
| name | illustrate |
|---|---|
| watch | Monitor source file changes |
| preserveWatchOutput | By default, --watch clears the screen between compilation steps. If –preserveWatchOutput is specified, this behavior is disabled. |