File Options
Options that are used to configure how files are output.
outputFileStrategy
--router
.Accepts either
"members"
or"modules"
. Defaults to"members"
.
Please also see the Output File Structure guide for updated implementation details.
{
"outputFileStrategy": "members"
}
flattenOutputFiles
Accepts a boolean value. Defaults to
false
.
By default output files are generated in a directory structure that mirrors the project’s module hierarchy including folders for member kinds eg classes
, enums
, functions
etc.
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
{
"flattenOutputFiles": false
}
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.
{
"fileExtension": ".mdx"
}
entryFileName
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 value of the
--entryModule
option (if defined). - The resolved Readme file (skipped if the
--readme
option is set tonone
). - The documentation index page.
{
"entryFileName": "index"
}
modulesFileName
The file name of the separate modules / index page.
Accepts a string value. Defaults to
"modules | packages | globals"
.
Please note this option is not applicable when --readme
is set to “none” or --mergeReadme
is set to “true”.
{
"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.
This option has no effect when --readme
is set to "none"
.
{
"mergeReadme": false
}