---
title: Quick Start
description: Get your documentation site up and running in under 5 minutes.
icon: rocket
---

# Quick Start

This guide gets you from zero to a live documentation site in under 5 minutes.

## Prerequisites

- Node.js 18+ or Bun installed
- A terminal

## Step 1: Install the CLI

<CodeGroup>

```bash title="curl"
curl -fsSL https://get.syntext.dev | sh
```

```bash title="Homebrew"
brew install syntext-dev/tap/stx
```

```bash title="npm"
npm install -g @syntext/cli
```

</CodeGroup>

## Step 2: Create Your Project

```bash
mkdir my-docs && cd my-docs
stx init --name "My Docs" --create
```

This creates:
- `syntext.json` — Site configuration
- `docs/index.mdx` — Home page
- `docs/guides/getting-started.mdx` — First guide
- `public/` — Static assets folder

## Step 3: Start Development

```bash
stx dev
```

This deploys a preview and outputs your URL:

```
✓ Preview: https://dev--my-docs.syntext.dev
```

## Step 4: Write Content

Edit `docs/index.mdx`:

```mdx
---
title: Welcome
description: Documentation for My Product
---

# Welcome to My Docs

Get started with our product in minutes.

<CardGroup cols={2}>
  <Card title="Quick Start" href="/guides/getting-started">
    Learn the basics
  </Card>
  <Card title="API Reference" href="/api-reference">
    Explore the API
  </Card>
</CardGroup>
```

Save the file — the browser updates instantly.

## Step 5: Deploy

```bash
stx deploy
```

Your docs are now live at `my-docs-docs.syntext.dev`.

## Next Steps

<CardGroup cols={2}>
  <Card title="Project Structure" href="/guides/project-structure">
    Organize your documentation
  </Card>
  <Card title="Writing Content" href="/guides/writing-content">
    Learn MDX and components
  </Card>
  <Card title="Configuration" href="/configuration/syntext-json">
    Customize your site
  </Card>
  <Card title="Components" href="/components/overview">
    Explore available components
  </Card>
</CardGroup>