QuiDocsConfig

This page contains an API reference for the QUI Docs configuration object. Refer to the config guide to learn about how to apply these properties.

API

Name & Description	Option(s)	Default
appDirectory Root app directory. NOT the full path to the directory.	string	'app'
disableCache Disable the file cache. This cache stores the result of parsed MDX files based on each file's md5 checksum. On subsequent edits, values are retrieved from the cache and parsing is avoided for files that have not changed.	boolean
headings ToC headings.	Array< \| 'h1' \| 'h2' \| 'h3' \| 'h4' \| 'h5' \| 'h6' >	['h2','h3','h4']
hotUpdateIgnore Matched files will not trigger a rebuild on hot update.	RegExp
navConfig Optional property for defining nav item hierarchy and page metadata.	NavConfig[]
pageDirectory Name of the directory where the MDX pages are located. NOT the full path to the directory. This is relative to the appDirectory.	string	'routes'
routingStrategy Strategy to use for building each route's path segments. Omit this property if you are using the default remix-flat-routes configuration.	\| 'vite-generouted' \| (( filePath: string, ) => string[])
typeDocProps Relative path to the typeDocProps json file. If the `<TypeDocProps />` component is used in an mdx page, the data for its referenced entity will be built into the search index for that page. Refer to the QUI typedoc guide to learn more.	string

appDirectory

Type

string

Default

'app'

Description

Root app directory. NOT the full path to the directory.

disableCache

Type

boolean

Description

Disable the file cache. This cache stores the result of parsed MDX files based on each file's md5 checksum. On subsequent edits, values are retrieved from the cache and parsing is avoided for files that have not changed.

headings

Type

Array<
  | 'h1'
  | 'h2'
  | 'h3'
  | 'h4'
  | 'h5'
  | 'h6'
>

Default

['h2','h3','h4']

Description

ToC headings.

hotUpdateIgnore

Type

RegExp

Description

Matched files will not trigger a rebuild on hot update.

navConfig

Type

NavConfig[]

Description

Optional property for defining nav item hierarchy and page metadata.

pageDirectory

Type

string

Default

'routes'

Description

Name of the directory where the MDX pages are located. NOT the full path to the directory. This is relative to the appDirectory.

routingStrategy

Type

| 'vite-generouted'
| ((
    filePath: string,
  ) => string[])

Description

Strategy to use for building each route's path segments. Omit this property if you are using the default remix-flat-routes configuration.

typeDocProps

Type

string

Description

Relative path to the typeDocProps json file. If the <TypeDocProps /> component is used in an mdx page, the data for its referenced entity will be built into the search index for that page.

Refer to the QUI typedoc guide to learn more.

PageFrontmatter

QuiDocsPluginOptions