End-to-End Tutorial
From an empty repo to a live docs site with a custom domain -- create a project, preview locally, deploy, and configure DNS.
Go from an empty repo to a live docs site with a custom domain. Skip any step you've done already.
Prerequisites
- A GitHub account
- A repository with docs content (or use the Starter Template)
- Node.js 20+ if you want local preview
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 changes before you push them to GitHub.
npm install -g jamdesk
cd your-docs
jamdesk devYour local preview runs at http://localhost:3000. Learn more in Local Preview.
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 <your-branch>Replace <your-branch> with the branch configured in your project (often main).
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.
- Go to Settings → Domains in the Jamdesk dashboard
- Add your domain (for example,
docs.example.com) - Create the DNS records shown in the dashboard
- Wait for verification and SSL to complete
For troubleshooting, see Custom Domains.
Validate the End-to-End Flow
- Your Jamdesk subdomain loads and shows the latest build
- Local preview reflects the same content and navigation
- The custom domain is verified and serving HTTPS
- Build history shows the latest commit and author attribution
Optional: Host at /docs
If you want docs on a subpath like example.com/docs, review Deployment Overview and Subpath Hosting.