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.

Prop	Type	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
knowledge Knowledge generation configuration for LLM integrations.	KnowledgeConfig
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'
pageTimestampMetadata Controls how page timestamp metadata is populated from git history.	\| 'off' \| 'timestamp' \| 'user-and-timestamp'	"off"
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[])
throwOnError Whether to throw an error if any issues occur during MDX processing.	boolean	false
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 made available for property documentation rendering. Refer to the QUI typedoc guide to learn more.	string
typeDocPropsOptions Options for TypeDoc property documentation.	{ includeInSearchIndex?: boolean }

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'
>

Description

ToC headings.

hotUpdateIgnore

Type

RegExp

Description

Matched files will not trigger a rebuild on hot update.

knowledge

Type

KnowledgeConfig

Description

Knowledge generation configuration for LLM integrations.

navConfig

Type

NavConfig[]

Description

Optional property for defining nav item hierarchy and page metadata.

pageDirectory

Type

string

Description

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

pageTimestampMetadata

Type

| 'off'
| 'timestamp'
| 'user-and-timestamp'

Description

Controls how page timestamp metadata is populated from git history.

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.

throwOnError

Type

boolean

Description

Whether to throw an error if any issues occur during MDX processing.

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 made available for property documentation rendering.

Refer to the QUI typedoc guide to learn more.

typeDocPropsOptions

Type

{
  includeInSearchIndex?: boolean
}

Description

Options for TypeDoc property documentation.

KnowledgeConfig

Knowledge generation configuration for LLM integrations. Presence of this config enables knowledge generation.

Prop	Type	Default
baseUrl Base URL for documentation links in the generated output.	string
exclude Glob patterns to exclude, relative to the resolved page directory. Supports full glob syntax via minimatch.	string[]

extraFiles Extra files to include in knowledge output beyond the generated page content.	KnowledgeExtraFile[]
frontmatter Configuration for which frontmatter fields to include in the generated Markdown output. Uses glob patterns for flexible field selection.	KnowledgeFrontmatterConfig
integrations Platform-specific integration configurations for uploading generated knowledge to external services.	{ openWebUi?: Array<{ envFile?: string id: string }> }
outputPath Output directory for generated knowledge files, relative to the public dir.	string	'exports'
pageIdPrefix Prefix to use for page IDs. Used to generate unique page IDs for knowledgebases that span multiple QUI Docs sites with potentially overlapping routes.	string

pages Configuration for whole-page JSON exports.	PagesExportConfig
sections Configuration for header-scoped section exports.	SectionExportConfig

baseUrl

Type

string

Description

Base URL for documentation links in the generated output.

exclude

Type

string[]

Description

Glob patterns to exclude, relative to the resolved page directory. Supports full glob syntax via minimatch.

extraFiles

Type

KnowledgeExtraFile[]

Description

Extra files to include in knowledge output beyond the generated page content.

frontmatter

Type

KnowledgeFrontmatterConfig

Description

Configuration for which frontmatter fields to include in the generated Markdown output. Uses glob patterns for flexible field selection.

integrations

Type

{
  openWebUi?: Array<{
    envFile?: string
    id: string
  }>
}

Description

Platform-specific integration configurations for uploading generated knowledge to external services.

outputPath

Type

string

Description

Output directory for generated knowledge files, relative to the public dir.

pageIdPrefix

Type

string

Description

Prefix to use for page IDs. Used to generate unique page IDs for knowledgebases that span multiple QUI Docs sites with potentially overlapping routes.

pages

Type