AI Knowledge

Overview

The knowledge system transforms MDX documentation into two JSON exports:

• sections.json — Header-scoped sections for RAG pipelines and semantic search
• pages.json — Full page content for LLM context windows and OpenWebUI upload

Content processing includes:

• Replacing <TypeDocProps /> components with JSON property documentation
• Inlining demo source code from referenced demo files
• Converting theme tables to JSON data
• Resolving relative imports and links

Generation runs automatically during buildStart (production builds) and configureServer (dev server initialization). The knowledge field on QuiDocsConfig enables generation — no enabled flag is required.

Configuration

Define the knowledge field in your qui-docs.config.ts:

import type {QuiDocsConfig} from "@qualcomm-ui/mdx-vite"
import {readFileSync} from "node:fs"
import {resolve} from "node:path"

export default {
  knowledge: {
    baseUrl: "https://docs.example.com",
    exclude: ["**/internal/**", "*guide+/swagger*"],
    extraFiles: [
      {
        contents: readFileSync(
          resolve(__dirname, "../some-package/CHANGELOG.md"),
          "utf-8",
        ),
        id: "changelog",
      },
    ],
  },
} satisfies QuiDocsConfig

string

string[]

exclude: ['**/internal/**', 'guide/drafts/*', '*.draft.mdx']

KnowledgeExtraFile[]

KnowledgeFrontmatterConfig

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

string

'exports'

string

`table-`

PagesExportConfig

SectionExportConfig

string

string[]

exclude: ['**/internal/**', 'guide/drafts/*', '*.draft.mdx']

KnowledgeExtraFile[]

KnowledgeFrontmatterConfig

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

string

string

`table-`

PagesExportConfig

SectionExportConfig

string

string

boolean

string

string

string

boolean

string

string[]

string[]

string[]

string[]

number[]

[1, 2, 3]

number

0

string

'sections.json'

number[]

number

string

string

'pages.json'

string

Output Structure

Generated files are written to {publicDir}/{outputPath}/. The default output path is exports.

string

string

SectionEntry[]

number

1

string

string

SectionEntry[]

number

1

Array<{
  code: string
  language: string
}>

string

string

string[]

["Button", "Examples", "Variants"]

number

Record<
  string,
  unknown
>

string

string

string

"button-examples-variants"

string[]

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

string

Array<{
  code: string
  language: string
}>

string

string

string[]

["Button", "Examples", "Variants"]

number

Record<
  string,
  unknown
>

string

string

string

"button-examples-variants"

string[]

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

string

string

string

PageEntry[]

number

1

string

string

PageEntry[]

number

1

string

string

string

string

"/components/button"

string

string

string

string

string

"/components/button"

string

Page Header UI

When knowledge is configured, each documentation page displays two actions in the page header:

• Copy Page — Copies the page content as Markdown to the clipboard
• Download Page — Downloads the page as a .md file

Both actions fetch content from pages.json at runtime. They only appear on pages that have a corresponding entry in the generated output.

OpenWebUI Integration

Upload generated knowledge to OpenWebUI instances. The upload command auto-detects pages.json in the output directory and uploads each page as an individual file.

export default {
  knowledge: {
    baseUrl: "https://docs.example.com",
    integrations: {
      openWebUi: [{id: "production"}, {id: "staging", envFile: ".env.staging"}],
    },
  },
} satisfies QuiDocsConfig

string

string

string

string

# Upload to all configured integrations
qui-mdx-vite upload-knowledge

# Upload to specific integrations
qui-mdx-vite upload-knowledge -i production,staging

# Override the knowledge file path
qui-mdx-vite upload-knowledge -p ./custom/exports

# Force upload even if content unchanged
qui-mdx-vite upload-knowledge --force