Getting Started
Publish your first Syntext docs site in a few minutes — in the browser, no install needed, or from your terminal.
This guide walks you through publishing your first Syntext docs site. Most teams start in the dashboard — nothing to install:
| Dashboard | CLI | |
|---|---|---|
| Best for | Writing and publishing in the browser | Working locally in your own editor |
| You need | A Syntext account | macOS or Linux, a terminal and a code editor |
| Your pages | Written in Syntext, uploaded as Markdown, or from a GitHub repository | Files in your repository |
| Start at | Start in the dashboard | Work 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):
<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:
{subdomain}-docs.syntext.dev) and who can read the docs.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.
syntext.json (or a Mintlify mint.json / docs.json). Up to 50 MB; images up to 5 MB each, SVGs up to 512 KB.syntext.json).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
stx is a single binary, so no Node.js or Bun is neededInstallation
Install the Syntext CLI globally:
Verify the installation:
Step 1: Initialize
Log in, then scaffold a new site:
This creates the following structure:
Step 2: Start Development
This deploys a preview build and outputs your URL:
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.
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:
Your docs are now live at my-docs-docs.syntext.dev.
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:
Embedded in App Repo
Documentation inside .syntext/ or .stx/:
The CLI auto-detects which layout is in use. Commands like stx dev and stx deploy work identically in both cases.