Quickstart

Get up and running with your documentation

Follow these steps to customize your documentation site.

Configure Your Site

Edit docs.json to customize:

  • name - Your documentation site name
  • colors - Primary, light, and dark theme colors
  • logo - Light and dark mode logos
  • navigation - Sidebar structure and pages

Add Content

1
Create MDX Files

Add .mdx files to your project root. Each file becomes a page.

2
Update Navigation

Add your new pages to the navigation section in docs.json.

3
Push to GitHub

Commit and push your changes. Jamdesk will build and deploy automatically.

Available Components

Jamdesk includes many built-in components:

ComponentDescription
CardHighlight key information with icons
CardGroupDisplay cards in a grid layout
TabsOrganize content in tabbed sections
StepsShow sequential instructions
AccordionCollapsible content sections
CalloutNotes, warnings, and tips

Learn More

Visit the Jamdesk documentation for the full component reference and customization options.