# UI-Theme Docs

> Setup guides for UI-Theme on React, Vue, Nuxt, and React Native.

- Documentation: https://uitheme.thally.app
- GitHub: https://github.com/tonyedgal/ui-theme-docs
- Full docs for LLMs: https://uitheme.thally.app/llms-full.txt
- Agent discovery (ai.txt): https://uitheme.thally.app/ai.txt
- Structured docs index (JSON): https://uitheme.thally.app/api/docs-index
- OpenAPI spec: https://uitheme.thally.app/openapi.yaml

## For AI agents

Every page supports content negotiation on its human URL:
- JSON API: append `?format=json` or send `Accept: application/json`
- JSON-LD: append `?format=ldjson` or send `Accept: application/ld+json`
- Markdown: append `?format=md` or send `Accept: text/markdown`
- Per-page API: https://uitheme.thally.app/api/docs/{page-id}
- Search API: https://uitheme.thally.app/api/search?q={query}
- Capability manifest (skill): https://uitheme.thally.app/skill.md
- Agent guidance (editing these docs): https://uitheme.thally.app/AGENTS.md
- MCP server (attach docs as native tools): https://uitheme.thally.app/api/mcp
- Agent readiness: https://uitheme.thally.app/api/agent-readiness
- Changelog feed (JSON Feed): https://uitheme.thally.app/changelog/feed.json
- Changelog feed (RSS): https://uitheme.thally.app/changelog/rss.xml

### Recommended workflow

1. Use this index, the search API, or `search_sections` / `search_docs` before choosing a page.
2. Read the smallest set of relevant pages and follow their prerequisite links.
3. Treat the published docs as the source of truth. Label inferences and say when evidence is missing.
4. Cite the canonical human page URLs, not only API endpoints.
5. Use `/AGENTS.md` before editing a repository. The public MCP server is read-only.

## Setup guides

### Overview

- [UI-Theme overview](https://uitheme.thally.app/): UI-Theme adds light mode, dark mode, system mode, and named color palettes to your app.
- [Installation](https://uitheme.thally.app/installation): This page helps you choose a package and install it.

### Web setup

- [Next.js](https://uitheme.thally.app/setup/nextjs): This guide sets up uitheme-web in a Next.js app.
- [Vite and React](https://uitheme.thally.app/setup/vite-react): This guide sets up uitheme-web in a React single-page app built with Vite.
- [TanStack Start](https://uitheme.thally.app/setup/tanstack-start): This guide sets up uitheme-web in a TanStack Start app.
- [Vue](https://uitheme.thally.app/setup/vue): This guide sets up uitheme-vue in a Vue 3 app built with Vite.
- [Nuxt](https://uitheme.thally.app/setup/nuxt): This guide sets up uitheme-vue in a Nuxt 4 app with server rendering.

### Native setup

- [React Native and Expo](https://uitheme.thally.app/setup/react-native-expo): This guide sets up uitheme-rn in an Expo or React Native app.
- [NativeWind](https://uitheme.thally.app/setup/nativewind): This guide connects uitheme-rn to NativeWind 5.
- [Uniwind](https://uitheme.thally.app/setup/uniwind): This guide connects uitheme-rn to Uniwind.

### Shared

- [Theme CSS](https://uitheme.thally.app/setup/theme-css): This page shows the CSS that the web packages need.
- [Transitions](https://uitheme.thally.app/setup/transitions): This page shows how to turn on animated theme changes.

### Help

- [Troubleshooting](https://uitheme.thally.app/troubleshooting): This page lists setup problems and their fixes.

## Changelog

- [Changelog](https://uitheme.thally.app/changelog): Record product changes that alter how readers use the documented experience.