AI Knowledge

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

PagesExportConfig

Description

Configuration for whole-page JSON exports.

sections

Type

SectionExportConfig

Description

Configuration for header-scoped section exports.

KnowledgeExtraFile

Extra content to include in knowledge output. Assumed to be Markdown.

Prop	Type
contents The Markdown content for this file.	string
id Unique identifier for this file, used for the output filename.	string
processAsMdx Whether to process this file as MDX content, replacing relative URLs, and applying other transformations as if the file were authored as mdx documentation.	boolean
title Display title for this content.	string

contents

Type

string

Description

The Markdown content for this file.

Type

string

Description

Unique identifier for this file, used for the output filename.

processAsMdx

Type

boolean

Description

Whether to process this file as MDX content, replacing relative URLs, and applying other transformations as if the file were authored as mdx documentation.

title

Type

string

Description

Display title for this content.

KnowledgeFrontmatterConfig

Prop	Type
exclude Glob patterns for frontmatter fields to exclude (applied after include).	string[]
include Glob patterns for frontmatter fields to include in output. Use ["*"] to include all fields.	string[]

exclude

Type

string[]

Description

Glob patterns for frontmatter fields to exclude (applied after include).

include

Type

string[]

Description

Glob patterns for frontmatter fields to include in output. Use ["*"] to include all fields.

SectionExportConfig

Configuration for header-scoped section exports.

Prop	Type	Default
depths Header depths that define section boundaries.	number[]	[1, 2, 3]
minContentLength Minimum content length to create a section entry.	number	0
outputPath Output path for sections.json, relative to the public directory.	string	'sections.json'

depths

Type

number[]

Description

Header depths that define section boundaries.

minContentLength

Type

number

Description

Minimum content length to create a section entry.

outputPath

Type

string

Description

Output path for sections.json, relative to the public directory.

PagesExportConfig

Configuration for whole-page exports.

Prop	Type	Default
outputPath Output path for pages.json, relative to the public directory.	string	'pages.json'

outputPath

Type

string

Description

Output path for pages.json, relative to the public directory.

KnowledgeSections

Output structure for the sections.json export.

Prop	Type
generatedAt	string
hash	string
sections	SectionEntry[]
totalSections	number
version	1

generatedAt

Type

string

hash

Type

string

sections

Type

SectionEntry[]

Description

totalSections

Type

number

version

Type

SectionEntry

A single section entry extracted from documentation.

Prop	Type
codeExamples Code examples extracted from this section.	Array<{ code: string language: string }>
content Prose content with code blocks removed. Used for formatted output.	string
hash Hash of this section's contents. Includes codeExamples, metadata, headerPath, and rawContent.	string
headerPath Breadcrumb path of headers leading to this section.	string[]

headingLevel Depth of this section's heading (1-6). Matches the heading that starts this section (e.g. an h2 section has headingLevel 2).	number
pageFrontmatter Frontmatter from the source page.	Record< string, unknown >
pageId Source page identifier.	string
rawContent Raw markdown content from the AST, including code blocks.	string
sectionId Generated section ID for anchor links.	string

terms Search terms extracted from ::: terms ::: blocks within this section.	string[]
types Name of the types or interfaces described by typeDocProps in this section.	Array<{ props: Array<{ defaultValue?: string description: string name: string propType?: \| 'input' \| 'output' required: boolean since?: string type: string }> since?: string type: string }>
url URL with anchor to this specific section.	string

codeExamples

Type

Array<{
  code: string
  language: string
}>

Description

Code examples extracted from this section.

content

Type

string

Description

Prose content with code blocks removed. Used for formatted output.

hash

Type

string

Description

Hash of this section's contents. Includes codeExamples, metadata, headerPath, and rawContent.

headerPath

Type

string[]

Description

Breadcrumb path of headers leading to this section.

headingLevel

Type

number

Description

Depth of this section's heading (1-6). Matches the heading that starts this section (e.g. an h2 section has headingLevel 2).

pageFrontmatter

Type

Record<
  string,
  unknown
>

Description

Frontmatter from the source page.

pageId

Type

string

Description

Source page identifier.

rawContent

Type

string

Description

Raw markdown content from the AST, including code blocks.

sectionId

Type

string

Description

Generated section ID for anchor links.

terms

Type

string[]

Description

Search terms extracted from ::: terms ::: blocks within this section.

types

Type

Array<{
  props: Array<{
    defaultValue?: string
    description: string
    name: string
    propType?:
      | 'input'
      | 'output'
    required: boolean
    since?: string
    type: string
  }>
  since?: string
  type: string
}>

Description

Name of the types or interfaces described by typeDocProps in this section.

url

Type

string

Description

URL with anchor to this specific section.

KnowledgePages

Output structure for the pages.json export.

Prop	Type
generatedAt	string
hash	string
pages	PageEntry[]
totalPages	number
version	1

generatedAt

Type

string

hash

Type

string

pages

Type

PageEntry[]

Description

totalPages

Type

number

version

Type

PageEntry

A single page entry containing the full raw markdown content.

Prop	Type
content Full raw markdown content of the page.	string
hash MD5 hash for change detection.	string
pageId Source page identifier.	string
pathname Route pathname.	string

title Page title.	string