Skip to content

Deployment ​

After generating your documentation, deploy it to any major hosting provider. KodaDocs produces a static VitePress site that can be hosted anywhere.

Supported Providers ​

ProviderCommandRequired Environment Variables
Cloudflare PagescloudflareCLOUDFLARE_API_TOKEN, CLOUDFLARE_ACCOUNT_ID
VercelvercelVERCEL_TOKEN
NetlifynetlifyNETLIFY_AUTH_TOKEN, NETLIFY_SITE_ID
GitHub Pagesgithub-pagesPush access to the repository
KodaDocs HostedkodadocsKODADOCS_LICENSE_KEY (Pro)

Deploy via CLI ​

bash
# Deploy to a specific provider
kodadocs deploy . --provider cloudflare

# Deploy to Vercel
kodadocs deploy . --provider vercel

# Deploy to Netlify
kodadocs deploy . --provider netlify

Deploy During Generation ​

Add --deploy to the generate command to deploy immediately after building:

bash
kodadocs generate . --deploy

KodaDocs Hosted (Pro) ​

Pro subscribers can deploy to *.kodadocs.com for hassle-free hosting:

bash
kodadocs deploy . --provider kodadocs --license-key kd_pro_xxx --slug my-app-docs

Your docs will be available at my-app-docs.kodadocs.com.

Auto-Detection ​

KodaDocs detects your project's deployment platform during the analysis phase. If it detects Vercel, Cloudflare, Netlify, or another platform, it suggests the matching deploy provider automatically.

Manual Deployment ​

The generated static site lives at ./docs/.vitepress/dist/. You can deploy this directory to any static hosting:

bash
# Build is already done by kodadocs generate
ls docs/.vitepress/dist/

# Upload to any static host
# e.g., rsync to your server
rsync -avz docs/.vitepress/dist/ user@server:/var/www/docs/

Custom Domains ​

After deploying, configure your custom domain through your hosting provider's dashboard:

  1. Add a CNAME record pointing to your hosting provider
  2. Configure the custom domain in the provider's dashboard
  3. Enable HTTPS (usually automatic with modern providers)

Was this page helpful?

Powered by KodaDocs