Kiira
ChevronDown
Github

Example config

A complete annotated Kiira configuration showing include, exclude, tsconfig, packageMode, defaultValidate, overrides, fixtures, and languages in context.

A full annotated config

This example uses every option so you can see how they fit together. Most projects need only include.

import { defineConfig } from "kiira-core"
export default defineConfig({
// Markdown files to check (required).
include: ["docs/**/*.md", "docs/**/*.mdx", "README.md"],
// Files to skip even if matched by `include`.
exclude: ["docs/api/**", "**/*.generated.md"],
// TypeScript config used to compile snippets.
// Omit to auto-resolve tsconfig.docs.json, then tsconfig.json.
tsconfig: "tsconfig.docs.json",
// Resolve package imports against workspace sources (monorepo-aware).
packageMode: "workspace",
// Full type-checking by default; override per fence with `validate=`.
defaultValidate: "type",
// Docs often declare unused imports for illustration — keep this off.
checkUnusedSymbols: false,
// Relative imports in docs often don't exist locally — keep this off.
// Bare package imports are always checked regardless.
checkRelativeImports: false,
// Languages Kiira checks (this is the default).
languages: ["ts", "tsx", "js", "jsx"],
// Per-glob compiler option overrides for multi-framework docs.
overrides: [
{
include: ["docs/solid/**/*.mdx"],
jsxImportSource: "solid-js",
},
{
include: ["docs/preact/**/*.mdx"],
jsxImportSource: "preact",
},
],
// Shared setup injected into snippets that opt in via `fixture=`.
fixtures: {
setup: {
type: "prepend", content: `import { createApp } from "your-lib"\nconst app = createApp()`,
},
},
// Apply the `setup` fixture to every fence unless overridden.
defaultFixture: "setup",
})

For the meaning and defaults of each option, see the Options reference.