Deployment
Deploy your documentation to production with automatic builds
Jamdesk handles deployment automatically. Connect your GitHub repository, push changes, and your docs go live within minutes.
How It Works
Commit and push your changes to the connected branch:
git add .
git commit -m "Update authentication docs"
git pushJamdesk detects your push and starts building. Your MDX files are compiled to optimized HTML with:
- Minified CSS and JavaScript
- Optimized images
- Generated search index
- Pre-rendered pages
Built files deploy to a global CDN. Your docs load fast from anywhere in the world.
Build times depend on project size. Most docs sites build in 30-90 seconds.
Deployment Status
Check your deployment status in the Jamdesk dashboard:
| Status | Meaning |
|---|---|
| Building | Build in progress |
| Deployed | Live at your domain |
| Failed | Build error - check logs |
| Queued | Waiting for previous build |
Manual Rebuild
Sometimes you need to rebuild without pushing changes:
- Go to your project in the Jamdesk dashboard
- Open Settings
- Click Rebuild
Use this when:
- Updating environment variables
- Fixing a stuck build
- Refreshing after platform updates
Custom Domains
Adding a Domain
Go to Settings → Domains → Add Domain
Enter your domain (e.g., docs.example.com)
Add a CNAME record pointing to your Jamdesk URL:
docs.example.com CNAME your-project.jamdesk.dev
DNS changes can take up to 48 hours. Jamdesk will show "Verified" when ready.
SSL Certificates
Jamdesk automatically provisions and renews SSL certificates for all domains. No configuration needed.
Environment Variables
Set build-time variables in Settings → Environment:
ANALYTICS_ID=UA-12345678-1
API_BASE_URL=https://api.example.com
Access them in your docs with environment variable syntax.
Build Logs
View detailed build logs for debugging:
- Go to Deployments in your project
- Click on a specific deployment
- View the full build log
Common issues appear in logs:
- Invalid MDX syntax
- Missing images
- Broken internal links
- Configuration errors
Rollbacks
Need to revert to a previous version?
- Go to Deployments
- Find the deployment you want to restore
- Click Rollback
The previous version goes live immediately while a new build starts.
Branch Deployments
Branch deployments are available on Pro plans.
Preview changes before merging to main:
- Push to a feature branch
- Jamdesk creates a preview at
branch-name.your-project.jamdesk.dev - Review and merge when ready
Webhook Integration
Trigger builds from external systems using webhooks:
curl -X POST "https://api.jamdesk.com/projects/YOUR_PROJECT/rebuild" \
-H "Authorization: Bearer YOUR_API_KEY"Find your API key in Settings → API.