Quickstart
Create a ready-to-use documentation project with create-heyo-docs.
The fastest way to start with Heyo Docs is create-heyo-docs. The creator
generates a standalone project, lets you choose a framework, and sets up your
first documentation page.
Create a project
Run the creator and answer its questions about the project directory, framework, deployment target, theme, and package manager. When it finishes, follow the printed commands to move into the new directory and start the development server:
bun create @heyo-sh/heyo-docsThen edit content/index.mdx and configure the site name, description, and
navigation in heyo-docs.config.ts. Read the
content guide to learn more about the file
structure.
Choose create-heyo-docs when starting a new project. The
generated starter also includes SEO configuration, a sitemap,
robots.txt, RSS, and files for AI agents.
Manual installation
Manual installation is useful when documentation needs to live inside an existing application. Find complete framework-specific instructions in the articles below.
React Router
Add Heyo Docs to an existing React Router application.
Next.js
Configure documentation in an existing Next.js App Router application.
Astro
Add Heyo Docs to an existing Astro project.
When your documentation is ready, continue with deployment to Vercel or Cloudflare.