End-to-End Tutorial

Create your first 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)

Use the Jamdesk CLI to preview page edits 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. When it looks right, publish it with the Git workflow in the next step.

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

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

Replace main with the branch configured in your project if you use a different branch.

When the build finishes, your docs are live at your-project.jamdesk.app. See Deployment for details.

Make your docs production-ready with your own domain when you are ready to use it outside 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.