{
// Set to `true` to reindent the HTML output files. Set to `false` to generate output files more
// quickly, but with extra whitespace.
"beautify": true,
// Components to display in each HTML output file.
"components": {
// Set to `true` to display a summary section at the top of each page. Set to `false` to omit
// the summary section.
"summary": true
},
// Maps CSS class names used in the template files to class names used in the output files.
// IMPORTANT: The CSS class names in the template files will change. For now, don't use this
// option.
//"cssClassMap": "",
// The character encoding to write to the tag in HTML output files. You are strongly
// encouraged to use the default setting.
"encoding": "utf-8",
// The locale for displaying localized text.
"locale": "en",
// Set to `true` to convert text from Markdown to HTML or `false` to disable Markdown support.
"markdown": true,
// The path to the directory that contains resource files for each locale.
"resourcePath": "./lang",
"sourceFiles": {
// Set to `true` to generate pretty-printed HTML versions of the source files, and to link to
// the pretty-printed files from the documentation. Set to `false` to omit the pretty-printed
// source files and the links to these files.
"generate": true,
// Set to `true` to include a single link to the source file in the documentation, near the
// top of the page. Set to `false` to include a source-file link with each symbol in the
// documentation.
"singleLink": true
},
"tables": {
// Set to `true` to embed child properties of parameters within the same table row as the
// parameter. Set to `false` to list child properties on their own rows.
"nestedPropertyTables": true
},
// set to `true` to exclude the nav section. Useful when `bodyContentOnly === true`.
"excludeNav": false,
// Whether the docs are being embedded. This will add 'rmd-embed' className to the
// tag as well as either `rmd-embed--no-nav` or `rmd-embed--with-nav`, depending
// on the value of the `excludeNav` option.
//
// This has no affect if `bodyContentOnly === true`.
"embedded": false,
// The name of the theme cookie. It will look for this cookie in order
// to update the theme (light/dark). Not applicable if
// `bodyContentOnly === true`.
"themeCookie": "",
// The default theme (light/dark) to use. Not applicable if
// `bodyContentOnly === true`.
"defaultTheme": "light",
// Optional classNames to add to the tag. Not applicable
// if `bodyContentOnly === true`.
"htmlTagClassName": "",
// Output data about the docs. Useful for things like embedding the docs.
// Each of the properties will be a `.js` file with a default Object export.
"dataOutput": {
// The relative path to a directory where data about the docs should be output.
// If not provided, the data won't be output. Use the additional
// options to define what exactly is output.
"dir": "",
"doclets": false,
"docletsTree": false,
"longnameToUrl": false,
"longnameToSrcUrl": false,
"navData": false,
// Same as "navData", except that it'll be in nested form
"navTree": false,
// The base url (xyz.html, no hash) to the itemId (its longname)
"navUrlBaseToItemId": false,
// The doclets that were not included in the rendered docs.
// The `excludedDocletsWithHash` is especially useful, since
// it often indicates a problem with the way the symbols
// were documented.
"excludedDocletsWithHash": false,
// This is less useful than `excludedDocletsWithHash`, since
// this is typically inline declarations that are known
// not to be included.
"excludedDocletsWithoutHash": false
}
// When `true`, only the will be rendered (but not wrapped in ).
// Useful when embedding docs.
"bodyContentOnly": false,
// The base path to use for the links. Useful when embedding. For example,
// `/docs` would result in links being added to link tags as
// `/docs/rendered_file.html` rather than "rendered_file.html".
"linksBasePath": "",
// The relative path to a .json file (or .js with default Object export)
// that maps the absolute path of source files to a boolean indicating
// whether the source code should be output in the documentation.
//
// This has no affect unless `sourceFiles.generate === true`.
//
// Any source files whose path has `true` in this Object will not
// be rendered, and instead the template will show `Source Code: not published`
// (rather than a link).
//
// This Object is opt-out, so any files **not** in this map will
// be rendered. So it is only necessary to add the paths of files
// that should be excluded.
"privateSrcFilesMap": "",
}