Usage guides.

Getting Started

Install it, render your first document, and drop a single section or item into a page you already have.

CLI

Generate a static documentation site from a spec file in one command, with no frontend toolchain: every command, flag, and CI recipe.

Configuration

Every option on the config object: which sections to show, what starts expanded, theming, side-panel containment, host-page offsets, and Markdown output.

Without Parser

For documents you already hold as an object. AsyncAPI and OpenAPI components, their props, and what each one renders.

With Parser

For raw YAML or JSON strings. The renderer components and imperative helpers, with parse diagnostics separate from render errors.

Deep linking

Open the docs on a specific endpoint, schema, or message, and keep the address bar in sync as people click around.

Composables

Render one item or one section on its own, or arrange several under a shared provider, for both AsyncAPI and OpenAPI.

Plugins

Add your own UI to a rendered document from a separately-installed package — a "Try it" tab, an inline action, a top-bar control, and how to write and publish one.

Extensions

The x-* fields apiuikit recognises, where each one appears, and how to switch them all off.

Avro Schemas

Rendering Avro payloads: the schemaFormat values recognised, and what a document needs to carry.

Protobuf Schemas

Rendering Protobuf payloads: the schemaFormat values recognised, and what a document needs to carry.

AI Export

Make your docs readable by agents and crawlers: the copy button, hosted Markdown URLs, and build-time file generation.

Web Components

Use apiuikit from Vue, Angular, Svelte, or plain HTML through full-document and section custom elements.