End-to-End Tutorial

Create a project in the Jamdesk dashboard and connect a repository.

• Follow Creating Projects to set the project name, slug, and docs path
• If prompted, install the GitHub App and grant repository access (Connecting GitHub)

Preview page edits with the Jamdesk CLI before you push them to GitHub.

npm install -g jamdesk
cd your-docs
jamdesk dev

Your local preview runs at http://localhost:3000. Learn more in Local Preview.

Open an .mdx page in your editor. Save a change and refresh the local preview. Publish it with the Git workflow in the next step.

Every push to your configured branch triggers a build. The build publishes to your Jamdesk subdomain.

git add .
git commit -m "Add docs content"
git push origin main

Replace main with your project's configured branch.

Your docs go live at your-project.jamdesk.app when the build finishes. See Deployment for details.

Serve your docs from your own domain instead of the Jamdesk subdomain.

1. Go to Settings → Domains in the Jamdesk dashboard
2. Add your domain (for example, docs.example.com)
3. Create the DNS records shown in the dashboard
4. Wait for verification and SSL to complete

For troubleshooting, see Custom Domains.