PraisonAIUI

PraisonAIUI Monorepo

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.

Quick Start

Installation

# Python CLI (compiler)
pip install praisonaiui

# TypeScript runtime (React/Next.js)
npm install praisonaiui

Usage

1. Create your config file:

# aiui.template.yaml
site:
  title: "My Docs"

content:
  docs:
    dir: "./docs"

templates:
  docs:
    layout: "ThreeColumnLayout"
    slots:
      main: { type: "DocContent" }

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

1. Run the CLI:

aiui build

1. Start your Next.js dev server:

npm run dev

Packages

Package	Description	Install
src/praisonaiui	CLI + compiler	pip install aiui
src/praisonaiui-ts	React runtime + Next.js adapter	npm install praisonaiui

Documentation

• Getting Started
• Configuration Guide
• API Reference

Development

# Clone the repo
git clone https://github.com/MervinPraison/PraisonAIUI.git
cd PraisonAIUI

# Install Python package in dev mode
pip install -e .[dev]

# Install TypeScript package
cd src/praisonaiui-ts
pnpm install

Running Tests

# Python tests (from repo root)
pytest tests -v

# TypeScript tests
cd src/praisonaiui-ts && pnpm test

Engineering Principles

• DRY: Schema defined once, shared across packages
• TDD: Tests first, implementation second
• Minimal Impact: Smallest change that solves the problem

License

MIT © Praison Limited