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

curl -fsSL https://get.syntext.dev | sh

brew install syntext-dev/tap/stx

npm install -g @syntext/cli

Step 2: Create Your Project

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

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:

---
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

stx deploy

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

Next Steps