/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Guides Quick Start

Quick Start

Get your documentation site live in under 5 minutes — in the browser or from your terminal.

1 min read

This guide gets you from zero to a live documentation site in under 5 minutes — in the browser with nothing to install, or from your terminal.

In the browser

1.
Sign up at app.syntext.dev and choose New project.
2.
Name the project, then pick where your docs live: Write in Syntext (start from a template), Upload files (a .zip or folder of Markdown), or Connect GitHub.
3.
Select Create and publish. Your site is live at your-project-docs.syntext.dev.

Keep writing in the web editor and select Publish when you're ready. More detail: Getting Started and Write and publish without GitHub.

From the command line

Prefer your own editor? The stx CLI does the same from your terminal.

Prerequisites

•
macOS or Linux (x64 or arm64) — stx is a single binary
•
A terminal

Step 1: Install the CLI

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

Step 2: Create Your Project

bash
stx login
stx init my-docs --preset workbench --create
cd my-docs

This creates:

•
syntext.json — Site configuration, on the Workbench preset
•
docs/index.mdx — Home page, built from the home components
•
docs/quickstart.mdx — First guide
•
public/ — Static assets folder

Step 3: Start Development

bash
stx dev

This deploys a preview and outputs your URL:

text
Preview: https://dev--my-docs-docs.syntext.dev

Step 4: Write Content

Edit docs/quickstart.mdx:

mdx
---
title: Quickstart
description: Get started with My Product
---
# Quickstart
Get started with our product in minutes.
<CardGroup cols={2}>
<Card title="Install" href="/install">
Set up My Product
</Card>
<Card title="First steps" href="/first-steps">
Learn the basics
</Card>
</CardGroup>

Save the file — the preview is rebuilt; refresh to see it.

Step 5: Deploy

bash
stx deploy

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

Next Steps

Was this page helpful? Yes No
Product
Resources
Company
© 2026 SyntextBuilt with Syntext