File Options

Options that are used by the plugin’s routers to configure how files are output.

fileExtension

💡

Specify the file extension for generated output files.

Accepts a string value. Defaults to ".md".

Typically Markdown files are recognised by the .md or .markdown file extensions..mdx maybe required for compatibility with certain Markdown parsers.

typedoc.json


{
  "fileExtension": ".mdx"
}

entryFileName

💡

The file name of the entry page.

Accepts a string value. Defaults to "README".

The entryFileName in this context is the root page of the documentation and each module directory. This is essentially the equivalent to index.html for web pages.

README is recognised when browsing folders on repos and Wikis and is the plugin default. index might be more suitable for static site generators.

The content of root documentation file will be resolved in the following order:

The resolved Readme file (skipped if the “readme” option is set to none).
The documentation index page.

typedoc.json


{
  "entryFileName": "index"
}

modulesFileName

💡

The file name of the separate modules / index page.

Accepts a string value. Defaults to "undefined".

By default the page is named either “modules”, “packages” or “globals” depending on the context.

Note: this option is NOT applicable when "readme" is set to "none" or "mergeReadme" is set to true.

typedoc.json


{
  "modulesFileName": "documentation"
}

mergeReadme

💡

Appends the documentation index page to the readme page.

Accepts a boolean value. Defaults to false.

By default when a readme file is resolved, a separate readme page is created. This option appends the documentation main/index page to the readme page so only a single root page is generated.

Note:

This option has no affect when "readme" is set to "none".
For packages readmes (when "outputFileStrategy" is set to "packages") this is the default behaviour.

typedoc.json


{
  "mergeReadme": false
}

flattenOutputFiles

💡

Flatten output files to a single directory.

Accepts a boolean value. Defaults to false.

By default output files are generated in a directory structure.

This option will flatten the output files to a single directory as follows:

README.md
module-a.Class.ClassA.md
module-a.Class.ClassB.md
module-a.Function.FunctionA.md
module-a.Function.FunctionB.md
module-b.Class.ClassA.md
module-b.Class.ClassB.md

Note: This option only affects custom routers.

typedoc.json


{
  "flattenOutputFiles": false
}

excludeScopesInPaths

💡

Exclude writing @ scope directories in paths.

Accepts a boolean value. Defaults to false.

By default, directories are split by scopes when generating file paths.

This option removes the @scope reference from the path when generating files and directories. It does not affect the name of the package or module in the output.

Note: This option only affects custom routers.

typedoc.json


{
  "excludeScopesInPaths": false
}