---
title: Jamdesk Documentation
sidebarTitle: Introduction
description: Create AI-ready docs with Jamdesk, a software documentation tool built on MDX and GitHub. Deploy in seconds with built-in search, analytics, and themes.
---

<YouTube id="7sYbBOdbS2I" />

Jamdesk is a [software documentation tool](https://www.jamdesk.com) that builds docs sites from your Markdown files. Connect a GitHub repo, write in MDX, and deploy globally in seconds. You don't need to set up a build pipeline or run any DevOps yourself. Every site generates an `llms.txt` file so AI tools can index your content.

<Info>
**Write with AI.** Use Cursor, Claude, or any AI assistant to generate and edit your docs. MDX is a text format that AI tools understand natively, so no special prompts are needed.
</Info>

## A Minimal Jamdesk Project

```text
my-docs/
├── docs.json
└── introduction.mdx
```

That's all you need. See the [Quickstart](/quickstart) to create yours.

<Tip>
Browse the [source for this documentation](https://github.com/jamdesk/jamdesk-docs) on GitHub. It's a working Jamdesk project you can use as a reference.
</Tip>

## What's Included

<Columns cols={2}>
  <Card title="Deploy in Seconds" icon="rocket" href="/how-jamdesk-works">
    Push to GitHub and your docs deploy to a global CDN. No build configs or CI pipelines.
  </Card>
  <Card title="Write in MDX" icon="file-code" href="/content/mdx-basics">
    Standard Markdown with React components for interactive elements.
  </Card>
  <Card title="Three Themes" icon="paintbrush" href="/customization/theming">
    Jam, Nebula, and Pulsar. Each ships with dark mode and responsive design.
  </Card>
  <Card title="Built-in Search" icon="magnifying-glass" href="/setup/search-analytics">
    Cmd+K search that indexes your content automatically.
  </Card>
</Columns>

## How It Works

<Steps>
  <Step title="Write in MDX">
    Create docs using Markdown with optional React components. Use your favorite editor: VS Code, Cursor, or any plain text editor. AI tools like Claude can generate and edit MDX natively.
  </Step>
  <Step title="Push to GitHub">
    Commit your changes and push. You don't need to run a build command or maintain a deploy script.
  </Step>
  <Step title="Live in Seconds">
    Jamdesk detects your push, builds your site, and deploys to a global CDN. Your docs are live at `your-project.jamdesk.app`.
  </Step>
</Steps>

## What You Can Build

<Tabs>
  <Tab title="Product Docs">
    User guides, feature documentation, and help centers. Clear navigation helps users find answers fast. [See components →](/components/overview)
  </Tab>
  <Tab title="API Reference">
    Endpoint documentation with syntax-highlighted code examples, request/response samples, and authentication guides. [See OpenAPI support →](/api-reference/openapi-example)
  </Tab>
  <Tab title="Developer Guides">
    Tutorials, quickstarts, and integration guides. Step-by-step components make complex procedures digestible. [See an example →](/end-to-end-tutorial)
  </Tab>
</Tabs>

## More Features

<Columns cols={2}>
  <Card title="AI Chat" icon="comment" href="/ai/chat">
    Built-in chat assistant answers visitor questions from your docs.
  </Card>
  <Card title="MCP Integration" icon="plug-circle-bolt" href="/ai/mcp-server">
    AI agents query your docs via Model Context Protocol.
  </Card>
  <Card title="Built-in Analytics" icon="chart-line" href="/setup/analytics-overview">
    Page views, search queries, and geographic data without third-party tools.
  </Card>
  <Card title="OpenAPI Support" icon="plug" href="/api-reference/openapi-example">
    Auto-generate API pages from your OpenAPI 3.0+ spec.
  </Card>
  <Card title="Custom Domains" icon="globe" href="/deploy/custom-domains">
    Serve from `docs.yourcompany.com` with automatic SSL.
  </Card>
  <Card title="SEO Ready" icon="magnifying-glass-chart" href="/content/seo">
    Meta tags, Open Graph images, and sitemaps generated automatically.
  </Card>
</Columns>

## Get Started

<Columns cols={2}>
  <Card title="Quickstart" icon="play" href="/quickstart">
    Deploy your first docs site in 5 minutes
  </Card>
  <Card title="CLI Guide" icon="terminal" href="/cli/overview">
    Set up local development
  </Card>
  <Card title="MDX Basics" icon="file-lines" href="/content/mdx-basics">
    Learn to write documentation
  </Card>
  <Card title="Components" icon="puzzle-piece" href="/components/overview">
    Explore available components
  </Card>
</Columns>

