Skip to main content

Documentation Index

Fetch the complete documentation index at: https://mintlify.com/jamdesk/jamdesk-cli/llms.txt

Use this file to discover all available pages before exploring further.

MDX lets you embed interactive, structured UI directly inside your Markdown pages. Jamdesk ships over 50 built-in components that are available in every .mdx file with no imports and no configuration — just use them. From callout boxes that draw the reader’s eye to multi-language code groups and fully interactive API parameter tables, the component library covers the patterns that appear most often in technical documentation. Every component works identically in the local dev server and in production.

​
Callouts

Callouts draw attention to information that deserves special emphasis. There are four semantic variants, each rendered with a distinct icon and colour.
Use <Note> for neutral supplementary information — something useful but not critical to the main flow.
Use <Tip> for best-practice suggestions or shortcuts that save the reader time.
Use <Warning> when the reader could cause data loss, downtime, or a security issue if they proceed without reading.
Use <Info> for contextual background — definitions, version notes, or platform-specific caveats.
<Note>This is a note.</Note>

<Tip>This is a tip.</Tip>

<Warning>This is a warning.</Warning>

<Info>This is informational context.</Info>

​
Cards

Use <Card> to link out to related pages or highlight key concepts. Wrap multiple cards in <CardGroup> to display them in a responsive grid. 
<CardGroup cols={2}>
  <Card title="Quick Start" icon="rocket" href="/quickstart">
    Get your first docs site running in under five minutes.
  </Card>
  <Card title="Configuration" icon="gear" href="/configuration">
    Learn every option available in docs.json.
  </Card>
</CardGroup>
Use cols={3} for denser grids when linking to many pages at once: 
<CardGroup cols={3}>
  <Card title="Dev Server" icon="server" href="/dev-server">Start locally.</Card>
  <Card title="Components" icon="puzzle" href="/components-overview">Browse components.</Card>
  <Card title="OpenAPI" icon="code" href="/openapi">Generate API reference.</Card>
</CardGroup>

​
Code Blocks

Standard fenced code blocks get syntax highlighting for any language. Always include a language tag: 
```typescript
const greet = (name: string): string => `Hello, ${name}!`;
```

​
CodeGroup

<CodeGroup> lets readers switch between multiple code samples — ideal for showing the same concept in several languages or package managers. Use it by wrapping multiple labeled code fences inside a <CodeGroup> tag: 
npm install -g jamdesk

​
Tabs

<Tabs> and <Tab> let you present alternative content in the same space — useful for platform-specific instructions, different SDK languages, or before/after comparisons: 
curl -fsSL https://get.jamdesk.com | bash

​
Accordions

<Accordion> collapses content under a heading, reducing visual noise on pages with many FAQ items or optional details: 
<Accordion title="What Node.js version does Jamdesk require?">
  Jamdesk requires **Node.js v20.0.0 or later**. Run `node --version` to check
  your version, or use a version manager like `nvm` to switch.
</Accordion>
Group multiple accordions together for an FAQ section: 
<AccordionGroup>
  <Accordion title="Is Jamdesk free?">
    Jamdesk has a free tier for public docs. See the pricing page for details.
  </Accordion>
  <Accordion title="Does it work offline?">
    The dev server works fully offline. Deployment requires an internet connection.
  </Accordion>
</AccordionGroup>

​
Steps

<Steps> and <Step> render numbered sequential instructions. Use these for setup guides, tutorials, and any workflow where order matters:
1

Install the CLI

npm install -g jamdesk
2

Create a new project

jamdesk init my-docs
cd my-docs
3

Start the dev server

jamdesk dev
Your docs are live at http://localhost:3000.

​
API Components

For API reference pages, Jamdesk provides components that render structured parameter and response documentation.

​
ParamField

Documents a request parameter — query string, path variable, body field, or header: 
<ParamField query="limit" type="integer" default="20">
  Maximum number of results to return. Must be between 1 and 100.
</ParamField>

<ParamField body="email" type="string" required>
  The user's email address. Must be a valid RFC 5322 address.
</ParamField>

​
ResponseField

Documents a field in an API response: 
<ResponseField name="id" type="string">
  Unique identifier for the resource, prefixed with `usr_`.
</ResponseField>

<ResponseField name="created_at" type="string">
  ISO 8601 timestamp of when the resource was created.
</ResponseField>

​
Expandable

Nest <Expandable> inside <ResponseField> to document nested object properties without cluttering the page: 
<ResponseField name="address" type="object">
  <Expandable title="address fields">
    <ResponseField name="address.line1" type="string">Street address.</ResponseField>
    <ResponseField name="address.city" type="string">City name.</ResponseField>
    <ResponseField name="address.country" type="string">ISO 3166-1 alpha-2 country code.</ResponseField>
  </Expandable>
</ResponseField>

​
All Components

The examples above cover the most commonly used components. The full catalogue of 50+ components — including <Frame>, <Tooltip>, <Icon>, <Update>, and more — is documented at jamdesk.com/docs/components/overview.
Run jamdesk validate to catch MDX syntax errors before you deploy. Common issues like unescaped < characters and unclosed JSX tags are reported with file names and line numbers so they are easy to fix.

Build docs developers (and LLMs) love

Get started for freeTalk to us