Quickstart

Scaffold a Tangly project, edit a page, and ship a build.

~ 1 min read

Quickstart

Five minutes from empty directory to deployed static site.

Install
bash
```
bun add -D tangly
```
See Installation for pnpm/npm/yarn.
Scaffold
bash
```
bun x tangly init my-docs
cd my-docs
```
init prompts for a project name and template (basic, api, or starter-from-mintlify), then drops a docs.json plus a few starter pages.
Run dev
bash
```
bun x tangly dev
```
Opens at http://localhost:4321. Edits to docs.json or any *.mdx hot-reload in under 250ms. Drafts (draft: true frontmatter) are visible in dev and hidden in build.

Add a page

Create guides/concepts.mdx:

---
title: Concepts
description: Core ideas behind the product.
icon: book
---

# Concepts

Body content. Markdown, MDX, components — all of it works.

Reference it in docs.json:

json

{
  "navigation": {
    "tabs": [
      {
        "tab": "Guides",
        "groups": [
          {
            "group": "Get Started",
            "pages": ["introduction", "guides/concepts"]
          }
        ]
      }
    ]
  }
}

The browser refreshes without a server restart.

Build
bash
```
bun x tangly build
```
Static output lands in dist/. The adapter is auto-detected from your repo:

File present Adapter
vercel.json vercel
wrangler.toml / wrangler.jsonc cloudflare
Dockerfile node
(none) static
Override with --adapter <name>. See Deploying for the recipes.
Preview the build
bash
```
bun x tangly preview
```
Serves dist/ locally so you can sanity-check the production output before pushing.