Hyperdocs

Build Your First Docs Site

This tutorial walks you through creating a complete documentation site from scratch using Hyperdocs, from connecting your repository to publishing a live URL.

Prerequisites

A GitHub account with at least one repository
Node.js 18+ installed locally
A free Hyperdocs account

Step 1 — Create a Project

Log in to your Hyperdocs dashboard and click New Project. Enter a name and select your repository from the GitHub integration list.

Step 2 — Run the Generator

Once your project is linked, click Generate. The AI pipeline will scan your repository and produce an initial doc structure within a few minutes.

Step 3 — Edit and Organise

Use the editor to review the generated pages. Drag and drop items in the sidebar to reorganise, and click any page to edit its content.

Step 4 — Publish

bash
hyperdocs deploy --env production