Documentationdocs

Introduction

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.

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.

What's included

Ready-made pages

Example pages for getting started, writing content, and API references.

50+ components

Cards, callouts, tabs, steps, code groups, accordions — no imports needed.

OpenAPI rendering

Auto-generate endpoint pages from a YAML or JSON spec.

Auto-deploy

Push to GitHub and your docs build and deploy in seconds.

A minimal Jamdesk project

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

Quickstart

Edit pages locally, customize, and deploy.

Components

Browse every built-in component with live examples.