mirror of
https://github.com/MervinPraison/PraisonAIUI.git
synced 2026-11-07 05:56:17 -10:00
MervinPraisonandClaude Opus 4.8
afce1e542d
The shipped docs site is built by `aiui build` from aiui.template.yaml (see ci.yml / deploy-pages.yml), not mkdocs.yml. Add a Frontend nav group so the playbook is discoverable in the built site navigation. Co-Authored-By: Claude Opus 4.8 <[email protected]>
156 lines
3.5 KiB
YAML
156 lines
3.5 KiB
YAML
schemaVersion: 1
|
|
|
|
site:
|
|
title: "PraisonAIUI Docs"
|
|
description: "Documentation for PraisonAIUI - YAML-driven website generator"
|
|
ui: "shadcn"
|
|
theme:
|
|
preset: "zinc"
|
|
radius: "md"
|
|
darkMode: true
|
|
|
|
seo:
|
|
siteUrl: "https://ui.praison.ai"
|
|
titleTemplate: "%s | %s"
|
|
defaultImage: "/icon.svg"
|
|
robots:
|
|
index: true
|
|
follow: true
|
|
|
|
# Mintlify-style navigation: few tabs, many groups per tab
|
|
navigation:
|
|
tabs:
|
|
- tab: "Documentation"
|
|
groups:
|
|
- group: "Getting Started"
|
|
icon: "rocket"
|
|
prefix: "getting-started"
|
|
pages:
|
|
- index
|
|
- getting-started/installation
|
|
- getting-started/quickstart
|
|
- getting-started/cli
|
|
- getting-started/github-pages
|
|
- group: "Core Concepts"
|
|
icon: "lightbulb"
|
|
prefix: "concepts"
|
|
pages:
|
|
- concepts/architecture
|
|
- concepts/configuration
|
|
- concepts/templates
|
|
- concepts/slots
|
|
- concepts/providers
|
|
- group: "Features"
|
|
icon: "sparkles"
|
|
prefix: "features"
|
|
pages:
|
|
- features/content-sources
|
|
- features/navigation
|
|
- features/theming
|
|
- features/dark-mode
|
|
- features/seo
|
|
- features/hot-reload
|
|
- features/protocols
|
|
- group: "TypeScript"
|
|
icon: "file-code"
|
|
prefix: "typescript"
|
|
pages:
|
|
- typescript/index
|
|
- typescript/runtime
|
|
- typescript/nextjs
|
|
- typescript/components
|
|
- group: "Frontend"
|
|
icon: "layout"
|
|
prefix: "frontend"
|
|
pages:
|
|
- frontend/beautifului
|
|
- group: "Examples"
|
|
icon: "folder-open"
|
|
prefix: "examples"
|
|
pages:
|
|
- examples/basic
|
|
- examples/advanced
|
|
- tab: "API Reference"
|
|
groups:
|
|
- group: "API Reference"
|
|
icon: "code"
|
|
prefix: "api"
|
|
pages:
|
|
- api/cli
|
|
- api/features-api
|
|
- api/python
|
|
- api/sessions
|
|
- api/typescript
|
|
|
|
|
|
# Navbar actions
|
|
navbar:
|
|
primary:
|
|
type: "button"
|
|
label: "Get started"
|
|
href: "/docs/getting-started/quickstart"
|
|
links:
|
|
- label: "GitHub"
|
|
href: "https://github.com/MervinPraison/PraisonAIUI"
|
|
|
|
# Footer
|
|
footer:
|
|
socials:
|
|
github: "https://github.com/MervinPraison/PraisonAI"
|
|
x: "https://x.com/MervinPraison"
|
|
youtube: "https://youtube.com/@MervinPraison"
|
|
links:
|
|
- header: "Resources"
|
|
items:
|
|
- label: "GitHub"
|
|
href: "https://github.com/MervinPraison/PraisonAI"
|
|
- label: "Documentation"
|
|
href: "https://docs.praisonai.com"
|
|
- header: "Community"
|
|
items:
|
|
- label: "Twitter"
|
|
href: "https://x.com/MervinPraison"
|
|
- label: "YouTube"
|
|
href: "https://youtube.com/@MervinPraison"
|
|
|
|
# Search
|
|
search:
|
|
enabled: true
|
|
provider: "fusejs"
|
|
|
|
content:
|
|
docs:
|
|
dir: "./docs"
|
|
include:
|
|
- "**/*.md"
|
|
- "**/*.mdx"
|
|
|
|
templates:
|
|
docs:
|
|
layout: "ThreeColumnLayout"
|
|
slots:
|
|
header: { ref: "header_main" }
|
|
left: { ref: "sidebar_docs" }
|
|
main: { type: "DocContent" }
|
|
footer: { ref: "footer_main" }
|
|
|
|
components:
|
|
header_main:
|
|
type: "Header"
|
|
props:
|
|
logoText: "PraisonAIUI"
|
|
|
|
footer_main:
|
|
type: "Footer"
|
|
props:
|
|
text: "© 2026 PraisonAI"
|
|
|
|
sidebar_docs:
|
|
type: "DocsSidebar"
|
|
props:
|
|
source: "docs-nav"
|
|
|
|
routes:
|
|
- match: "/docs/**"
|
|
template: "docs"
|