CmdocsDeployment Overview
Deploy your cmdocs site via the cmdocs Dashboard — connect a Git repo, push to deploy.
Deployment
cmdocs is push-to-deploy. Connect your GitHub repository to the cmdocs dashboard, and every commit to your tracked branch produces a new deployment automatically. Builds, hosting, HTTPS, and custom domains are all handled for you — there is no local build command and no manual upload.
GitHub Integration
Connect a repo, watch the first build deploy.
Custom Domains
Point your own domain at a cmdocs site.
CI Validation
Run cmdocs check before committing.
What you get
| Feature | Description |
|---|---|
| Git integration | One-click GitHub OAuth + repo picker; webhooks configured for you |
| Auto-builds on push | Every commit to a tracked branch produces a fresh deployment |
| Multiple environments | Production, staging, and preview branches — each tracking its own branch |
| Subdomains + HTTPS | Each environment gets <slug>.cmdocs.app with TLS provisioned automatically |
| Custom domains | Bring your own domain — DNS instructions in project settings |
| Build logs | Live, streaming logs per build; errors surface inline |
| Deployment history | Roll back to any previous deployment in one click |
| Preview screenshots | Automatic thumbnail of each deployed site |
How it works
A typical build completes in under a minute. Watch it happen in real time on the deployment detail page.
Validate locally before you push — cmdocs check runs the same validation the build worker does (schema, navigation references, frontmatter, assets, internal links). Failing early saves CI minutes and keeps broken deploys off main. See CI Validation.
Environments
Every project starts with a production environment tracking main. Add more environments for staging or feature branches:
| Environment | Branch | Subdomain | Triggers on |
|---|---|---|---|
production | main | <slug>.cmdocs.app | Push to main |
staging | develop | <slug>-staging.cmdocs.app | Push to develop |
preview | any PR | <slug>-pr-<n>.cmdocs.app | PR opened/updated |
Subdomains default to the project slug — override them per-environment in the environment settings.
Quick walkthrough
Sign in with GitHub at cmdocs.sh and authorize the cmdocs GitHub App on the repos you want to deploy.
Create a project and select your docs repository.
First build runs automatically — cmdocs reads docs.json, runs the pipeline, and produces a static site.
Visit your subdomain. Push another commit to see a fresh deployment in seconds.
For the full step-by-step with screenshots, see GitHub Integration.
What's next
How is this guide?