quickstart.mdx

title	Quickstart
description	Edit MDX files, preview locally with the Jamdesk CLI, then connect a GitHub repo for automatic deploys. Customize colors, branding, and navigation in docs.json.

Your docs are built from MDX files in this repository. Edit them locally with the CLI, then connect to Jamdesk for automatic builds on every push.

1. Preview locally

Install the Jamdesk CLI:

```bash npm npm install -g jamdesk ```

brew install jamdesk/tap/jamdesk

Start the dev server with hot reload:

jamdesk dev

Open http://localhost:3000. Edits to MDX files appear instantly.

2. Edit a page

Open any .mdx file and start writing. MDX supports standard Markdown plus Jamdesk components.

---
title: My Page
description: A brief description for SEO
---

# Heading

Regular markdown works — **bold**, *italic*, `code`, [links](https://example.com).

<Tip>
Jamdesk components like this Tip drop in without imports.
</Tip>

3. Add a new page

Add a new `.mdx` file anywhere in your project, for example `guides/deployment.mdx`. Open `docs.json` and add the page path to the `navigation` section:

```json
{
  "group": "Guides",
  "pages": ["guides/deployment"]
}
```

4. Customize your site

Everything is configured in docs.json:

Setting	What it does
name	Site name shown in the header
colors	Primary, light, and dark accent colors
logo	Light and dark mode logo images
theme	Visual theme (jam, nebula, or pulsar)
navigation	Sidebar tabs, groups, and page order
navbar	Top navigation links and buttons

See the full configuration reference at [jamdesk.com/docs/config/docs-json-reference](https://jamdesk.com/docs/config/docs-json-reference).

5. Connect GitHub for auto-deploy

Once your docs look right locally, hand off building and hosting to Jamdesk:

Create a repository and push your project. Sign in at [dashboard.jamdesk.com](https://dashboard.jamdesk.com), create a project, and connect your repository. Every push triggers an automatic build. Your site is live in seconds at `.jamdesk.app` or your custom domain.

What's next

Cards, callouts, tabs, steps, and more — all ready to use. Render endpoint pages from an OpenAPI spec, or hand-author with components.