Uai

contentdocumentation-page.tsx

Color theme

block · 80/108

Documentation Page

Navigation, an in-page table of contents with the current section, content, and page actions.

Install

Install manuallyView source on GitHub

Composes

  • documentation-page.tsx19
  • app-sidebar.tsx10
  • breadcrumb-trail.tsx1

Accessibility4 checks

  • Site navigation is an App Sidebar: a labelled nav with aria-current on the current page and a mobile disclosure.
  • The table of contents is a nav named by its title. The current section link carries aria-current="location", so position is not shown by color alone.
  • Content is an article named by the h1. Each section is labelled by its h2 and keeps a scroll margin so linked headings are not hidden.
  • Page actions are a labelled group of native buttons and links. The pager is a labelled nav with previous and next relationships.
canvasvariant="columns"content
Content and community

Build cache

Keep parsed templates and resized images between builds, so only changed pages do any work.

Turn on the cache

The cache is on by default from Kiln 4.2. Older projects opt in with one line in kiln.config.ts:

export default { cache: { dir: ".kiln/cache" } };

Share it in CI

Restore .kiln/cache before the build step and save it afterwards. A restored cache brings a 2,400-page site from 41 seconds to about 9.

Cache keys

Key the cache on your lockfile and Kiln version. Template and image entries are already keyed by content, so stale entries are never used.

Clear the cache

Run kiln cache clear after upgrading plugins that change output without changing their inputs.

documentation page layout

Code example

usage.tsx
"use client";import { BookOpen, Boxes, Rocket, Settings2 } from "lucide-react";import { useState } from "react";import {  DocumentationPage,  DocumentationPageAction,  DocumentationPageActionLink,  DocumentationPageActions,  DocumentationPageBreadcrumb,  DocumentationPageContent,  DocumentationPageDescription,  DocumentationPageHeader,  DocumentationPageMain,  DocumentationPageNav,  DocumentationPagePager,  DocumentationPagePagerLink,  DocumentationPageSection,  DocumentationPageSectionTitle,  DocumentationPageTitle,  DocumentationPageToc,  DocumentationPageTocItem,  DocumentationPageTocList,  DocumentationPageTocTitle,  type DocumentationPageVariant,} from "@/components/uai/documentation-page";import {  AppSidebarGroup,  AppSidebarGroupLabel,  AppSidebarHeader,  AppSidebarItem,  AppSidebarItemIcon,  AppSidebarItemLabel,  AppSidebarList,  AppSidebarMobileTrigger,  AppSidebarNav,  AppSidebarTitle,} from "@/components/ui/uai/app-sidebar";import { BreadcrumbTrailItem } from "@/components/ui/uai/breadcrumb-trail";export function DocumentationPagePreview({  variant = "columns",}: {  variant?: DocumentationPageVariant;}) {  const [copied, setCopied] = useState(false);  return (    <DocumentationPage variant={variant} defaultActiveSection="install">      <DocumentationPageNav defaultValue="caching">        <AppSidebarHeader>          <AppSidebarTitle>Kiln docs</AppSidebarTitle>          <AppSidebarMobileTrigger />        </AppSidebarHeader>        <AppSidebarNav aria-label="Documentation">          <AppSidebarGroup>            <AppSidebarGroupLabel>Get started</AppSidebarGroupLabel>            <AppSidebarList>              <AppSidebarItem value="quickstart">                <AppSidebarItemIcon>                  <Rocket size={16} />                </AppSidebarItemIcon>                <AppSidebarItemLabel>Quickstart</AppSidebarItemLabel>              </AppSidebarItem>              <AppSidebarItem value="concepts">                <AppSidebarItemIcon>                  <BookOpen size={16} />                </AppSidebarItemIcon>                <AppSidebarItemLabel>Core concepts</AppSidebarItemLabel>              </AppSidebarItem>            </AppSidebarList>          </AppSidebarGroup>          <AppSidebarGroup>            <AppSidebarGroupLabel>Guides</AppSidebarGroupLabel>            <AppSidebarList>              <AppSidebarItem value="caching">                <AppSidebarItemIcon>                  <Boxes size={16} />                </AppSidebarItemIcon>                <AppSidebarItemLabel>Build cache</AppSidebarItemLabel>              </AppSidebarItem>              <AppSidebarItem value="config">                <AppSidebarItemIcon>                  <Settings2 size={16} />                </AppSidebarItemIcon>                <AppSidebarItemLabel>Configuration</AppSidebarItemLabel>              </AppSidebarItem>            </AppSidebarList>          </AppSidebarGroup>        </AppSidebarNav>      </DocumentationPageNav>      <DocumentationPageToc>        <DocumentationPageTocTitle>On this page</DocumentationPageTocTitle>        <DocumentationPageTocList>          <DocumentationPageTocItem section="install">Turn on the cache</DocumentationPageTocItem>          <DocumentationPageTocItem section="ci">Share it in CI</DocumentationPageTocItem>          <DocumentationPageTocItem section="ci-keys" level={3}>            Cache keys          </DocumentationPageTocItem>          <DocumentationPageTocItem section="clear">Clear the cache</DocumentationPageTocItem>        </DocumentationPageTocList>      </DocumentationPageToc>      <DocumentationPageMain>        <DocumentationPageHeader>          <DocumentationPageBreadcrumb>            <BreadcrumbTrailItem href="#docs">Docs</BreadcrumbTrailItem>            <BreadcrumbTrailItem href="#guides" parent>              Guides            </BreadcrumbTrailItem>            <BreadcrumbTrailItem current>Build cache</BreadcrumbTrailItem>          </DocumentationPageBreadcrumb>          <DocumentationPageTitle>Build cache</DocumentationPageTitle>          <DocumentationPageDescription>            Keep parsed templates and resized images between builds, so only changed pages do any            work.          </DocumentationPageDescription>          <DocumentationPageActions>            <DocumentationPageAction              onClick={() => {                void navigator.clipboard?.writeText("https://kiln.example/docs/build-cache");                setCopied(true);              }}            >              {copied ? "Link copied" : "Copy link"}            </DocumentationPageAction>            <DocumentationPageActionLink href="#edit">Edit this page</DocumentationPageActionLink>          </DocumentationPageActions>        </DocumentationPageHeader>        <DocumentationPageContent>          <DocumentationPageSection id="install">            <DocumentationPageSectionTitle>Turn on the cache</DocumentationPageSectionTitle>            <p>              The cache is on by default from Kiln 4.2. Older projects opt in with one line in{" "}              <code>kiln.config.ts</code>:            </p>            <pre>              <code>{'export default { cache: { dir: ".kiln/cache" } };'}</code>            </pre>          </DocumentationPageSection>          <DocumentationPageSection id="ci">            <DocumentationPageSectionTitle>Share it in CI</DocumentationPageSectionTitle>            <p>              Restore <code>.kiln/cache</code> before the build step and save it afterwards. A              restored cache brings a 2,400-page site from 41 seconds to about 9.            </p>          </DocumentationPageSection>          <DocumentationPageSection id="ci-keys">            <DocumentationPageSectionTitle>Cache keys</DocumentationPageSectionTitle>            <p>              Key the cache on your lockfile and Kiln version. Template and image entries are              already keyed by content, so stale entries are never used.            </p>          </DocumentationPageSection>          <DocumentationPageSection id="clear">            <DocumentationPageSectionTitle>Clear the cache</DocumentationPageSectionTitle>            <p>              Run <code>kiln cache clear</code> after upgrading plugins that change output without              changing their inputs.            </p>          </DocumentationPageSection>        </DocumentationPageContent>        <DocumentationPagePager>          <DocumentationPagePagerLink direction="previous" href="#concepts">            Core concepts          </DocumentationPagePagerLink>          <DocumentationPagePagerLink direction="next" href="#config">            Configuration          </DocumentationPagePagerLink>        </DocumentationPagePager>      </DocumentationPageMain>    </DocumentationPage>  );}

Manual installation

documentation-page.tsx

Loading component source…

esc
ThinkingAI
MessageAI
CitationAI
AttachmentAI
Tool CallAI
Response StatusAI
Run SummaryAI
Conversation ThreadAI · Block
Research SessionAI · Block
File AnalysisAI · Block
Agent RunAI · Block
Approval CardFeedback
Empty StateFeedback
Status BannerFeedback
Progress SummaryFeedback
Inline FeedbackFeedback
Confirmation DialogFeedback
Activity TimelineFeedback
Skeleton GroupFeedback
Prompt ComposerForms
Form FieldForms
Search FieldForms
Filter BarForms
File UploadForms
Date Range PickerForms
Form Error SummaryForms
Unsaved Changes BarForms
Step IndicatorForms
Task ListData Display
Data Table ToolbarData Display
Metric CardData Display
Description ListData Display
Comparison TableData Display
Kanban BoardData Display
Calendar ViewData Display
Audit LogData Display
App HeaderNavigation
App SidebarNavigation
Breadcrumb TrailNavigation
Page TabsNavigation
Command MenuNavigation
Split PaneNavigation
Sign-in CardAuthentication
Sign-up CardAuthentication
Password RecoveryAuthentication
Code VerificationAuthentication · Block
Onboarding WizardAuthentication · Block
Workspace SetupAuthentication · Block
Coupon FieldCommerce
Quantity PickerCommerce
Cart ItemCommerce
Price SummaryCommerce
Order StatusCommerce
Product DetailCommerce · Block
Product ListingCommerce · Block
Cart DrawerCommerce · Block
CheckoutCommerce · Block
Order TrackingCommerce · Block
Subscription ManagementCommerce · Block
Announcement BarMarketing
Pricing ToggleMarketing
Testimonial CardMarketing
Product GalleryMarketing
Trust PanelMarketing
Newsletter FormMarketing
Hero SectionMarketing · Block
Feature ShowcaseMarketing · Block
Pricing SectionMarketing · Block
Testimonials SectionMarketing · Block
FAQ SectionMarketing · Block
Call to ActionMarketing · Block
Waitlist SectionMarketing · Block
Contact SectionMarketing · Block
Author CardContent
CommentContent
Reaction BarContent
Share MenuContent
Changelog EntryContent
Article PageContent · Block
Documentation PageContent · Block
Changelog PageContent · Block
Comment ThreadContent · Block
Community FeedContent · Block
Public ProfileContent · Block
Map FrameMaps
Map ControlsMaps
Map MarkerMaps
Map LegendMaps
Place CardMaps
Route SummaryMaps
Dashboard ShellApplication · Block
Settings PageApplication · Block
Profile PageApplication · Block
Team ManagementApplication · Block
Notification CenterApplication · Block
Billing PortalApplication · Block
Search ResultsApplication · Block
Resource ManagerOperations · Block
Data ExplorerOperations · Block
Import WorkflowOperations · Block
Approval QueueOperations · Block
Audit Log ViewerOperations · Block
Incident DashboardOperations · Block
Report BuilderOperations · Block
Document FieldBrazil
CEP FieldBrazil
Pix PaymentBrazil
Installment PickerBrazil