Deploy Command
docyard deploy --to github-pages
Builds and deploys your site in one step. Auto-detects the platform if --to is omitted.
Supported Platforms
| Platform | --to value |
Required CLI |
|---|---|---|
| Vercel | vercel |
npm i -g vercel |
| Netlify | netlify |
npm i -g netlify-cli |
| Cloudflare Pages | cloudflare |
npm i -g wrangler |
| GitHub Pages | github-pages |
gh |
Options
| Flag | Default | Description |
|---|---|---|
--to |
auto-detect | Target platform |
--no-prod |
false |
Deploy a preview instead of production |
--skip-build |
false |
Skip the build step and deploy existing output |
Platform Detection
When --to is omitted, the platform is detected from project files in this order:
| File or Directory | Detected Platform |
|---|---|
vercel.json or .vercel/ |
Vercel |
netlify.toml or .netlify/ |
Netlify |
wrangler.toml or wrangler.jsonc |
Cloudflare Pages |
.github/workflows/ |
GitHub Pages |
GitHub Pages
Pushes the built site to the gh-pages branch on your remote. Configure GitHub Pages to deploy from this branch:
- Go to Settings > Pages
- Set Source to Deploy from a branch
- Select gh-pages / / (root)
docyard deploy --to github-pages
For project sites, set the base path in your config:
build:
base: /repo-name
Vercel
docyard deploy --to vercel
Deploys to production by default. Use --no-prod for a preview deployment.
Authenticate first by running vercel login.
Netlify
docyard deploy --to netlify
Deploys to production by default. Use --no-prod to get a draft URL.
Authenticate first by running netlify login and link your site with netlify link.
Cloudflare Pages
docyard deploy --to cloudflare
The project name is derived from your site title in docyard.yml.
Authenticate first by running wrangler login.
Was this page helpful?
Thanks for your feedback!