PraisonAIUI

One YAML file → One complete website

PraisonAIUI is a YAML-driven website generator. Write one config file, point to a docs folder, run aiui build — get a modern, production-ready documentation site.

Philosophy

We are a wrapper, not a framework.

We integrate best-in-class libraries instead of reinventing them:

Feature	Library
Markdown	react-markdown + remark-gfm
UI Components	shadcn/ui
Theming	Tailwind CSS v4 + CSS variables
Validation	Pydantic

Quick Start

pip install aiui
aiui init
aiui build
aiui serve

Open http://localhost:8000 — your site is ready.

Configuration

# aiui.template.yaml
schemaVersion: 1

site:
  title: "My Docs"
  theme:
    preset: "blue"      # 22 Tailwind color presets available
    radius: "md"        # none, sm, md, lg, xl
    darkMode: true

content:
  docs:
    dir: "./docs"

# Auto-install shadcn components at build time
dependencies:
  shadcn:
    - accordion
    - tabs

templates:
  docs:
    layout: "ThreeColumnLayout"   # or TwoColumnLayout, CenteredLayout
    slots:
      main: { type: "DocContent" }

routes:
  - match: "/docs/**"
    template: "docs"

Layouts

Layout	Description
ThreeColumnLayout	Sidebar + Content + TOC (classic docs)
TwoColumnLayout	Sidebar + Content (no TOC)
CenteredLayout	Centered content, no sidebar
FullWidthLayout	Full-width content

Theme Presets

22 official Tailwind colors available:

zinc slate stone gray neutral red orange amber yellow lime green emerald teal cyan sky blue indigo violet purple fuchsia pink rose

Each with automatic light/dark mode support.

UI Styles

PraisonAIUI supports 5 distinct UI styles, selectable via --style:

Style	Flag	Frontend Layout	Best For
Docs	--style docs	ThreeColumnLayout	Documentation sites, knowledge bases
Chat	--style chat	ChatLayout (fullscreen, sidebar, floating widget)	Conversational AI, customer support, Q&A
Agents	--style agents	AgentUILayout (agent tabs + session history)	Multi-agent playground, agent experimentation
Playground	--style playground	PlaygroundLayout (input/output panels)	Prompt testing, side-by-side comparison
Custom	--style custom	User-defined	Custom layouts with full control

Chat Mode (default for aiui run)

aiui run app.py                    # fullscreen chat
aiui run chat.yaml                 # YAML-defined chat

Agents Mode (multi-agent playground)

aiui run app.py --style agents     # tabbed agent UI with sidebar

Docs Mode (default for aiui build)

aiui build                         # static documentation site
aiui serve                         # serve built docs

CLI Commands

aiui init              # Create aiui.template.yaml
aiui init --frontend   # Scaffold full React project
aiui validate          # Validate YAML config
aiui build             # Compile to static site
aiui serve             # Dev server with hot reload
aiui dev -e examples   # Dev dashboard with live switching

Architecture

aiui.template.yaml     →  aiui build  →  aiui/
       ↓                                    ├── index.html
    docs/*.md                               ├── docs/*.md
                                            ├── ui-config.json
                                            └── assets/

Development

git clone https://github.com/MervinPraison/PraisonAIUI.git
cd PraisonAIUI
pip install -e .[dev]
pytest tests -v

License

MIT © Praison Limited