Jamdesk Documentation logo

Build, Deploy & Analyze Overview

How docs go from git push to live site: the CLI, the build pipeline, hosting and custom domains, and the analytics that come with every page.

Push to GitHub (or run jamdesk deploy). Jamdesk builds the site. The changes go live. This section covers the CLI, what happens during a build, where your site is served from, and the analytics Jamdesk collects on every page without extra scripts.

Build failing? Build Troubleshooting matches common error messages to causes and fixes.

CLI

The open-source CLI previews docs locally, validates configuration, checks for broken links, and deploys.

CLI Overview

Install the CLI and learn the core commands

Authentication

Log in, token storage, and session management

CLI Deploy

How jamdesk deploy packages, uploads, and builds your docs

Fix Broken Links

jamdesk fix resolves broken internal links, previewing changes first

Build Workflow

Deployment Workflow

GitHub pushes, CLI deploys, status tracking, and manual rebuilds

Triggering Builds

Automatic on push, manual from the dashboard, plus debouncing and queues

Monitoring Builds

Real-time progress, build phases, and structured logs

Fix with AI

Review and apply AI-suggested fixes from the build dashboard

Automatic Image Conversion

PNG and JPG to WebP conversion at build time

PDF Export

Export your whole site as one PDF

Hosting & Domains

Your site starts at yourproject.jamdesk.app. You can serve it from your own domain or from a /docs path on your existing site.

Deployment Overview

Subdomain, custom domain, or subpath: compare the hosting options

Build & Deploy Lifecycle

The full pipeline from git push to live site

Custom Domains

DNS setup to serve docs from your own domain with SSL

Custom Domain Only

Stop the Jamdesk subdomain from answering directly

Jamdesk Subdomains

Naming rules and how to change your default subdomain

Subpath Hosting

Host at yoursite.com/docs instead of a separate subdomain

Platform Guides

Tested configurations for proxying /docs through your existing infrastructure.

AWS Route 53 & CloudFront

Distribution setup and origin configuration

Cloudflare Workers

Worker setup and routing for /docs traffic

Reverse Proxy

nginx, Apache, Caddy, Traefik, or HAProxy

Vercel

A vercel.json rewrite with the jd_proxy marker

Analytics & Monitoring

Analytics Overview

Page views, traffic sources, and search queries with no external scripts

Project Analytics

Visitor behavior for your site, privacy-focused

Search Analytics

What readers search for, and the content gaps it reveals

Mobile App

Build status and analytics on the go, with push notifications