Quickstart
Create a ready-to-use documentation project with create-heyo-docs.
Loading documentation…
Powered by heyo
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.
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:
Then edit content/index.mdx and configure the site name, description, and
theme in heyo-docs.config.ts. The starter
creates its first sidebar automatically; add explicit groups only when you
need a custom order. 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 is useful when documentation needs to live inside an existing application. Find complete framework-specific instructions in the articles below.
React RouterAdd Heyo Docs to an existing React Router application.
Next.jsConfigure documentation in an existing Next.js App Router application.
AstroAdd Heyo Docs to an existing Astro project.
When your documentation is ready, continue with deployment to Vercel or Cloudflare.