Cuitty Document
Documentation that ships as a site, an embed, or both.
TARGETS site · embed · headlessEDITOR cuitty-editor modal+richemits → editor, brand-sdk, observe, toolbar
One source. Three targets.
Write once, publish everywhere. A single DocGraph produces a full documentation site, an embeddable panel for your app, or headless JSON for any consumer. Use the target switcher above to see the same content in each chrome mode.
Site
Full navigation, search, and versioning. Deploys to any static host or Cuitty Cloud.
Embed
Drop a component into your app. Same content, same styles, no separate build step.
Headless
Raw JSON output for custom renderers, CLI help systems, or AI-agent consumption.
Auto dictionary. Contextual tooltips.
Define a term once and it appears everywhere your docs reference it. Dotted-underline terms show inline definitions on hover. The demo above keeps its controls focused on the three choices that affect this preview: page, target chrome, and theme.
Auto dictionary
Terms defined in the content model surface as hoverable tooltips across every page, embed, and headless output.
Reading controls
Scale, density, and contrast sliders let each reader tune the docs to their preference. Settings persist per browser.
Four modes. Generated social cards.
Every page declares a mode that drives its layout, metadata, and generated assets. Social cards are produced at build time in og, x-large, and square formats — open the card drawer in the demo to see them live.
doc Reference pages with sidebar nav and in-page TOC.
blog Date-ordered posts with author byline and reading time.
status Service health with incident history and uptime graph.
changelog Version entries with diff links and migration notes.
Theme families. Sub-theme cascade.
Themes derive from @cuitty/brand tokens.
A family defines the base; sub-themes override surfaces, type scale,
and accent. Switch at runtime with a single call — try the theme
switcher in the demo above.
setTheme("frauthy.dark") // by name
setTheme(2.1) // by number: family 2, sub-theme 1
Both forms are equivalent. Family frauthy = index 1,
cuitty = 2, mono = 3.
All CSS custom properties update in place.
CLI, admin, and audit — batteries included.
Every property gets a generated CLI. The admin CMS provides presence indicators, audit rail, and page-level permissions out of the box.
$ bun create cuitty-docs
scaffolding property in ./docs
installing @cuitty/document ...
done.
$ ./docs build
compiling 14 pages (3 modes)
generating social cards ...
build complete — dist/ 2.1 MB
$ ./docs connect remote
authenticating via device-code flow ...
connected to docs.example.com Admin CMS
AH JK
2m ago page/getting-started updated
5m ago dictionary term added: "DocGraph"
12m ago theme switched to frauthy.dark
Opt-in integrations. Zero bytes when off.
Observe, Toolbar, and Auth are opt-in. When disabled, they contribute zero bytes to the bundle. Enable them with a single DSL flag.
Observe Page-view telemetry, search analytics, and error reporting.
Toolbar Status bar with feature flags and presence across properties.
Auth Gated pages, per-role visibility, and session context.
Try it now
Cuitty Document is in preview. The SDK is complete, with full Solid and React components, a custom element embed, theme system, card engine, and generated CLI. Explore the source repository for implementation details.