1. Documentation
  2. Deploying
  3. Vercel
ReadmeGitHub
  • Introduction
  • Quickstart
  • Text
  • Code
  • Lists
  • Tables
  • Accordion
  • Badge
  • Button
  • Callout
  • Code Block
  • Code Block Group
  • Code Snippet
  • Columns
  • Custom components
  • GitHub
  • Hover Card
  • Mermaid
  • Properties
  • Related Topics
  • Tabs
  • Tree
  • Images
  • Video
  • Files
  • Grain
  • Shade
  • Moss
  • Configuration
  • Content
  • Navigation
  • Site Identity
  • Appearance
  • Header and Footer
  • Fonts
  • Icons
  • Integrations
  • Search
  • OpenAPI
  • AI Chat
  • React Router
  • Astro
  • Next.js
  • Cloudflare
  • Vercel
  • robots.txt
  • sitemap.xml
  • JSON-LD
  • rss.xml
  • llms.txt
  • llms-full.txt
  • .md endpoints

Vercel

Deploy a Heyo Docs project to Vercel with the framework setup generated by create-heyo-docs.

Loading documentation…

Cloudflare< Previousrobots.txtNext >

Powered by heyo

On this page

Create a Vercel projectSet the production URLDeployAdd environment variables when needed

Choose Vercel while creating a Heyo Docs project to get the correct framework adapter and production deploy script. Documentation pages and generated files are built with the site; Vercel runs server routes only for features that need them, such as Try it or AI Chat.

Create a Vercel project

Vercel is currently available in the creator for Next.js and Astro:

bun create @heyo-sh/heyo-docs acme-docs --template next --deployment vercel

Replace next with astro for Astro's Vercel adapter. React Router 8 is not currently supported by the Vercel deployment target in create-heyo-docs; use Cloudflare or select Configure later for that framework.

Set the production URL

Set siteUrl to the final public HTTPS address before creating a production build. Heyo Docs uses it for canonical metadata, the sitemap, RSS, and AI-discovery files.

heyo-docs.config.ts
export default heyoDocs({  siteUrl: "https://docs.acme.com",  title: "Acme Docs",  // ...});

Keep the canonical production URL in the configuration. Vercel preview URLs are useful for review, but they should not replace siteUrl in source control.

Deploy

Authenticate with Vercel, then run the project-local deployment script. On the first deployment, Vercel prompts you to link or create the project and runs the framework build automatically.

bash
bunx vercel loginbun run typecheckbun run deploy

bun run deploy runs vercel --prod. The generated project already contains the framework configuration Vercel needs, so do not replace it with a static export when the site uses server routes.

Add environment variables when needed

A documentation-only site does not need runtime variables. If AI Chat or an application route needs a secret, add it to the matching Vercel environment instead of committing it to the repository or exposing it in client-side configuration. Redeploy after changing a variable used during the build or at runtime.

Continue deploying

  • Configure an OpenAPI reference
  • Add AI Chat