Skip to content

README.md

Latest commit

 

History

History
190 lines (135 loc) · 5.6 KB

README.md

File metadata and controls

190 lines (135 loc) · 5.6 KB

Jamdesk Starter Template

License: MIT

The official starter template for Jamdesk documentation sites. Clone this repository to create beautiful, professional documentation in minutes.

Documentation · Get Started · Dashboard

What is Jamdesk?

Jamdesk is a modern documentation platform that transforms MDX (Markdown + React components) into polished, production-ready documentation websites.

Why teams choose Jamdesk:

  • Write in MDX - Markdown with React components for interactive docs
  • Deploy instantly - Push to GitHub, deploy globally in seconds
  • Professional themes - Three built-in themes (Jam, Nebula, Pulsar)
  • AI-ready - Auto-generates llms.txt for ChatGPT, Claude, Copilot
  • Built-in search - AI-powered search out of the box
  • Analytics included - Track page views and search queries

What's Included

This starter template includes everything you need to get started:

starter-docs/
├── docs.json              # Site configuration (theme, colors, navigation)
├── introduction.mdx       # Welcome page
├── quickstart.mdx         # Getting started guide
├── api-reference/         # API documentation example pages
│   ├── openapi-example.mdx          # Live-rendered OpenAPI endpoint
│   └── request-response-examples.mdx # Hand-authored request/response demo
├── components/            # Component examples
│   ├── callouts.mdx       # Notes, warnings, tips
│   ├── cards.mdx          # Card layouts
│   ├── steps.mdx          # Step-by-step guides
│   └── tabs-and-accordions.mdx
├── openapi/               # OpenAPI specification files
│   └── example-api.yaml   # Sample Acme Support API spec
└── writing/               # Content writing guides
    ├── code-blocks.mdx    # Syntax highlighting
    ├── components.mdx     # Using MDX components
    └── pages.mdx          # Page structure

Theme: This template uses the Jam theme - a clean, modern design with purple accent colors. See all themes →

Quick Start

Option 1: Use the Dashboard (Recommended)

  1. Sign up at dashboard.jamdesk.com
  2. Create a new project and select "Starter Template"
  3. Connect your GitHub repository
  4. Start editing - changes deploy automatically

Option 2: Use This Template

Click the green "Use this template" button at the top of this page to create your own repository based on this starter.

Option 3: Clone and Deploy

# Clone this template
git clone https://github.com/jamdesk/starter-docs.git my-docs
cd my-docs

# Preview locally (requires Jamdesk CLI)
npm install -g jamdesk
jamdesk dev

# Open http://localhost:3000

Then connect your repository to Jamdesk via the dashboard.

Customization

Change Theme Colors

Edit docs.json to customize your brand colors:

{
  "colors": {
    "primary": "#6366F1",
    "light": "#818CF8",
    "dark": "#4F46E5"
  }
}

Switch Themes

Change the theme in docs.json:

{
  "theme": "jam"      // Options: "jam", "nebula", "pulsar"
}

Add Your Logo

{
  "logo": {
    "light": "/images/logo-light.svg",
    "dark": "/images/logo-dark.svg"
  }
}

Writing Content

All content is written in MDX - Markdown with React components:

---
title: My Page
description: A brief description for SEO
---

# Welcome

This is regular Markdown with **bold** and *italic* text.

<Note>
  This is a callout component for important information.
</Note>

<Steps>
  <Step title="First">Do this first</Step>
  <Step title="Second">Then do this</Step>
</Steps>

Available components: Cards, Tabs, Accordions, Steps, Callouts, Code Groups, and 25+ more →

Local Development

Preview your docs locally with hot reload:

# Install the CLI (choose one)
npm install -g jamdesk          # via npm
brew install jamdesk/tap/jamdesk # via Homebrew

# Start the dev server
jamdesk dev

# Validate your docs
jamdesk validate

# Check for broken links
jamdesk broken-links

Documentation

Deploy

Jamdesk handles deployment automatically:

  1. Push changes to your connected GitHub repository
  2. Jamdesk builds your site (typically under 30 seconds)
  3. Your docs are live on your custom domain or yoursite.jamdesk.app

No build configuration required. No CI/CD setup needed.

Support

License

MIT - Use this template for any project, commercial or personal.

Built with Jamdesk - Beautiful documentation that developers actually love.