Skip to content

Latest commit

 

History

History
49 lines (40 loc) · 1.76 KB

File metadata and controls

49 lines (40 loc) · 1.76 KB
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.

**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

Example pages for getting started, writing content, and API references. Cards, callouts, tabs, steps, code groups, accordions — no imports needed. Auto-generate endpoint pages from a YAML or JSON spec. 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

Edit pages locally, customize, and deploy. Browse every built-in component with live examples.