PraisonAIUI¶
One YAML file, one docs folder, one command — ship a beautiful documentation site.
PraisonAIUI is a YAML-driven website generator that transforms a single configuration file and a docs folder into a modern, production-ready website.
✨ Features¶
-
:material-file-document: YAML-Driven
Configure your entire site with a single YAML file -
:material-puzzle: Component Slots
Flexible slot system for headers, sidebars, and content -
:material-palette: Theming
Dark mode, custom colors, and UI framework support -
:material-rocket-launch: Hot Reload
Instant rebuilds during development
Quick Start¶
How It Works¶
graph LR
A[aiui.template.yaml] --> B[aiui build]
C[docs/] --> B
B --> D[ui-config.json]
B --> E[docs-nav.json]
B --> F[route-manifest.json]
D --> G[Next.js App]
E --> G
F --> G
Example Configuration¶
site:
title: "My Docs"
content:
docs:
dir: "./docs"
templates:
docs:
layout: "ThreeColumnLayout"
slots:
main: { type: "DocContent" }
routes:
- match: "/docs/**"
template: "docs"
Next Steps¶
- Installation - Get PraisonAIUI installed
- Quick Start - Create your first project
- Configuration - Learn the YAML schema