/Docs
Search docs or ask a question⌘K
DocsAgent
Changelog
Home Getting Started Getting Started

Getting Started

Publish your first Syntext docs site in a few minutes — in the browser, no install needed, or from your terminal.

6 min read

This guide walks you through publishing your first Syntext docs site. Most teams start in the dashboard — nothing to install:

DashboardCLI
Best forWriting and publishing in the browserWorking locally in your own editor
You needA Syntext accountmacOS or Linux, a terminal and a code editor
Your pagesWritten in Syntext, uploaded as Markdown, or from a GitHub repositoryFiles in your repository
Start atStart in the dashboardWork from the command line

Both paths end with the same live site on your-project-docs.syntext.dev and the same web editor, so anyone on your team can edit pages in the browser afterwards.

Start in the dashboard

Create and publish a project without installing anything. Write your pages in Syntext, upload the Markdown you already have, or connect a GitHub repository — you edit them in the browser with the web editor either way. See Write and publish without GitHub.

Set up your account

When you sign up at app.syntext.dev you tick the box to accept the Terms and Privacy Policy, and you can opt in to product emails. Then you land straight in your workspace. Nothing is locked: you can look around projects, members, billing and themes right away.

At the top of Projects, Finish setting up Syntext walks you through four steps and shows how far you are (for example, 1 of 4 done):

1.
Verify your email. We send a link to the address you signed up with. Open it in any tab or on any device; the step ticks itself off when you come back. Didn't get it? Use Resend email (once a minute) or Change email to fix a typo.
2.
Tell us about you. Three quick questions: what you'll document, your role and your team size. You can skip it.
3.
Create your first project. One project is one docs site. Opens the new-project wizard below.
4.
Publish your docs. Deploy from your repository, or — for a project written in Syntext — open the editor and select Publish. Your site goes live at <project>-docs.syntext.dev.

You can collapse the guide to a single line or choose Hide for now. To bring it back from any page, use the progress ring in the sidebar (on phones, the pill in the top bar) or Setup guide in your account menu. When all four steps are done you'll see You're live, and then the guide goes away.

Verify before you make changes. Until your email is verified, you can browse but not change anything: creating projects, inviting teammates, deploying and editing wait for verification. If you try one, Syntext asks you to verify first and offers Resend email and Change email; once you've opened the link, choose Continue and your action goes ahead. See Email verification.

Create a project

For a new project at any time, go to app.syntext.dev/projects → New project and follow the three-step wizard:

1.
Name your project — the name, a subdomain (the wizard previews the live hostname, {subdomain}-docs.syntext.dev) and who can read the docs.
2.

Content — Where your docs live:

Skip for now creates the project with no pages; add them in the editor, or connect a repository later under Settings › Repository. See Write and publish without GitHub for templates, uploads and their limits.

◦
Write in Syntext — start from a template (Help centre, Product guides, Handbook, Developer docs or Blank) and write in the browser. No repository needed. Create and publish puts the site live at once.
◦
Upload files — drop a .zip or a folder of Markdown or MDX pages, images and syntext.json (or a Mintlify mint.json / docs.json). Up to 50 MB; images up to 5 MB each, SVGs up to 512 KB.
◦
Import from a URL — coming soon.
◦
Connect GitHub — connects a repository through the Syntext GitHub App: choose a GitHub account (or + Add account to install the App), search for the repository, then set the Branch (pushes here deploy to production) and the Docs path (the folder with syntext.json).
3.
Publish — the first build runs while you watch its progress; when it finishes, click Visit site. You can leave the page — the deploy keeps running.

Open your project → Editor to write and edit pages in the browser — no local setup. Your project's Overview also shows a Finish setting up checklist — connect repository, first deploy, add a custom domain, invite your team — that disappears once every item is done. Below it, Build with your favorite AI agent has Copy prompt, a ready-made prompt that connects Claude Code, Cursor, VS Code (GitHub Copilot) or Codex to your docs through the hosted MCP connector.

Work from the command line

Prefer your own editor and terminal? The stx CLI creates, previews and deploys the same site from your machine.

Prerequisites

•
macOS or Linux (x64 or arm64) — stx is a single binary, so no Node.js or Bun is needed
•
A code editor (VS Code recommended)
•
A terminal

Installation

Install the Syntext CLI globally:

curl (Recommended)Homebrew
curl -fsSL https://get.syntext.dev | sh

Verify the installation:

bash
stx --version

Step 1: Initialize

Log in, then scaffold a new site:

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

--preset starts the site on doc engine v2 with one of the presets. The --create flag creates a project on Syntext and links it automatically. If you prefer to do this manually, omit the flag and use stx connect later. See stx init for every option.

This creates the following structure:

text
my-docs/
├── syntext.json # Site configuration
├── docs.json
├── docs/
│ ├── index.mdx # Home page, built from the home components
│ └── quickstart.mdx
├── public/ # Static assets
└── .gitignore

Step 2: Start Development

bash
stx dev

This deploys a preview build and outputs your URL:

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

The address is dev--<slug>-docs.syntext.dev. Each time you save, the preview is rebuilt — refresh to see it.

Step 3: Edit Your First Page

Open docs/quickstart.mdx and make changes. Save, wait for the Deployed line, and refresh the preview.

mdx
---
title: Quickstart
description: The first steps with my-docs.
---
# Quickstart
This is my documentation site powered by Syntext.
<Note>
Edit this file at `docs/quickstart.mdx`.
</Note>

docs/index.mdx is your home page (/), and it shows what you write. On a doc engine v2 site, build it from the home components — a hero with a search box, section cards, your latest changelog entries — each drawn in your preset's style and filled from your site. See Home page.

Step 4: Deploy to Production

When you're ready to publish:

bash
stx deploy

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

Tip

Set up a custom domain like docs.yourcompany.com in your project → Settings › Domains in the dashboard.

Project Layouts

Syntext supports two project layouts:

Standalone Docs Repo

Configuration at the repository root:

text
my-docs/
├── syntext.json
├── docs/
├── public/
└── openapi.json

Embedded in App Repo

Documentation inside .syntext/ or .stx/:

text
my-api/
├── src/
├── package.json
└── .syntext/
├── syntext.json
├── docs/
└── public/

The CLI auto-detects which layout is in use. Commands like stx dev and stx deploy work identically in both cases.

Next Steps

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