---
title: Quickstart
description: Get a Thally documentation site running locally in under five minutes.
url: http://localhost:3040/quickstart
---

# Quickstart

Get a Thally documentation site running locally in under five minutes.

Follow these steps to go from zero to a running docs site.

![HTML browser window](/images/image2.jpg)

## Install and deploy

```bash
npx create-thally-docs my-docs
cd my-docs
npm run dev
```

Open [http://localhost:3040](http://localhost:3040) to see your new docs site.

Create `src/content/my-page.mdx`:

```mdx
---
title: My Page
description: A new documentation page.
---

Write your content here using Markdown and JSX components.
```

Open `docs.json` and add the page to a group:

```json
{
  "group": "Getting Started",
  "pages": ["introduction", "quickstart", "my-page"]
}
```

The sidebar updates automatically — no restart required.

Drop an OpenAPI spec (YAML or JSON) into the project root and reference it in `docs.json`:

```json
{
  "tab": "API Reference",
  "api": {
    "source": "openapi.yaml"
  }
}
```

Thally generates interactive endpoint pages with parameter tables, schemas, code samples, and a "Try It" console.

```bash
npm run build:cloudflare
npm run smoke:cloudflare
```

Deploy the verified Worker with `npm run deploy:cloudflare`. A traditional
Node deployment remains available through `npm run build && npm start`.

Set `THALLY_SITE_URL` in your hosting dashboard for correct OpenGraph URLs and metadata.