---
title: Introduction
description: Thally is an open-source documentation template built with Next.js, MDX, and Tailwind CSS.
url: http://localhost:3040/
---

# Introduction

Thally is an open-source documentation template built with Next.js, MDX, and Tailwind CSS.

Scaffold a new site and go from zero to a running docs app in minutes.

    Author pages in MDX with Steps, Tabs, Cards, Callouts, and more.

    A full library of layout, content, and API-reference building blocks.

    Drop in an OpenAPI spec for interactive endpoints and a "Try It" console.

    One `thally` binary to init, dev, build, deploy, migrate, and check your docs.

    Grounded chat, an Agent Readiness Score, and `llms.txt` out of the box.

    Merged (or preview) PRs in your product repos become reviewed docs PRs, drafted by the agent.

## What's included

    A unified content engine parses every page once into a typed graph — HTML, JSON, Markdown, search, and embeddings are all projections of one source of truth. Tabs, groups, hybrid search, Shiki code blocks, and an RSS-backed changelog ship in the box.

    The `thally` CLI hides the Next.js runtime behind a single binary. `create-thally-docs` scaffolds, migrates, and lints; `thally check --ci` fails PRs on broken links, anchors, and drift; and the docs agent drafts edits as reviewed pull requests — it never merges. **Thally Track** turns merged (or `docs-preview`-labelled) PRs in your product repos into docs PRs automatically, with org-wide access via a one-click GitHub App.

    Retrieval-grounded chat answers with inline citations — with a configurable assistant name and disclaimer — a deterministic Agent Readiness Score grades how well your docs serve agents, and `/llms.txt`, per-page JSON, and agent manifests let tools index everything. Every deployed site is also a remote MCP endpoint at `/api/mcp`.

    A live admin dashboard recolors the site with a brand-accent color picker, swaps per-mode (light/dark) logos and favicons, and toggles features — no redeploy. Automatic dark mode, a responsive sidebar-plus-TOC layout, dynamic OG images, built-in SEO, and a version switcher round it out. Team accounts add Owner/Editor/Viewer roles from a git-committed roster — no database, no per-seat pricing.

## Get started

The fastest way to create a new Thally project is with the CLI:

```bash
npx create-thally-docs my-docs
```

The CLI prompts you for a project name, description, brand preset, and optional GitHub repo URL — then scaffolds a ready-to-run docs site with starter content, navigation, and dependencies installed.

Prefer to clone the template manually?

```bash
git clone https://github.com/thallylabs/thally.git my-docs
cd my-docs
npm install
npm run dev
```

## How it works

Thally uses a file-based content model. All documentation lives in `src/content/` as `.mdx` files. Navigation structure is defined in `docs.json` at the project root — you list your tabs, groups, and pages there, and the sidebar, breadcrumbs, and routing are derived automatically.

For API documentation, point the API Reference tab in `docs.json` to an OpenAPI spec file. Thally parses the spec and generates endpoint pages with parameter tables, request/response schemas, code samples, and an interactive playground.

The pages in this Overview tab are example content that ships with the template. Replace them with your own product documentation to get started.