Vercel & Netlify

Deploy your documentation with zero configuration on Vercel or Netlify.

Vercel

Quick Deploy

1. Push your project to GitHub
2. Import the repository on vercel.com
3. Configure build settings:

1. Click Deploy

vercel.json

For more control, add a vercel.json:

{
  "buildCommand": "gem install docyard && docyard build",
  "outputDirectory": "dist",
  "installCommand": "echo 'skip'"
}

Custom Domain

1. Go to Settings > Domains
2. Add your domain
3. Update your config:

build:
  base: https://docs.example.com

Netlify

Quick Deploy

1. Push your project to GitHub
2. Import the repository on netlify.com
3. Configure build settings:

1. Click Deploy site

netlify.toml

For more control, add a netlify.toml:

[build]
  command = "gem install docyard && docyard build"
  publish = "dist"

[[redirects]]
  from = "/*"
  to = "/404.html"
  status = 404

Custom Domain

1. Go to Domain settings
2. Add your custom domain
3. Update your config:

build:
  base: https://docs.example.com

Environment Variables

Both platforms support environment variables for sensitive configuration.

Analytics

Instead of committing analytics IDs:

analytics:
  google: ${GOOGLE_ANALYTICS_ID}

Set GOOGLE_ANALYTICS_ID in your platform’s environment settings.

Preview Deployments

Both Vercel and Netlify automatically create preview deployments for pull requests. This lets you review documentation changes before merging.