---
title: Introduction
description: "Starter project with example pages, components, and API reference. Edit MDX, customize your theme, and ship docs in minutes — preview locally or auto-deploy from GitHub."
---

Welcome to your Jamdesk starter project. Everything you need to ship a polished documentation site is in this repo — edit the MDX files, tweak `docs.json`, and you're live.

<Tip>
**Built-in AI search.** Click the sparkles button in the top-right corner of the header — chat is grounded on this site's pages and works out of the box.
</Tip>

## What's included

<Columns cols={2}>
  <Card title="Ready-made pages" icon="file-lines">
    Example pages for getting started, writing content, and API references.
  </Card>
  <Card title="50+ components" icon="puzzle-piece" href="/components/cards">
    Cards, callouts, tabs, steps, code groups, accordions — no imports needed.
  </Card>
  <Card title="OpenAPI rendering" icon="plug" href="/api-reference/openapi-example">
    Auto-generate endpoint pages from a YAML or JSON spec.
  </Card>
  <Card title="Auto-deploy" icon="rocket">
    Push to GitHub and your docs build and deploy in seconds.
  </Card>
</Columns>

## A minimal Jamdesk project

```text
my-docs/
├── docs.json          # Site config: theme, colors, navigation
├── introduction.mdx   # This page
└── quickstart.mdx     # Your getting-started guide
```

That's all you need. Add more `.mdx` files to add more pages — the file path becomes the URL.

## Next steps

<Columns cols={2}>
  <Card title="Quickstart" icon="play" href="/quickstart">
    Edit pages locally, customize, and deploy.
  </Card>
  <Card title="Components" icon="puzzle-piece" href="/components/cards">
    Browse every built-in component with live examples.
  </Card>
</Columns>
