Core Concepts

Understanding a few key ideas will help you get the most out of Hyperdocs.

Projects

A project represents one documentation site. Each project maps to a single repository and has its own custom domain, navigation structure, and access controls.

Versions

Every time you publish, Hyperdocs creates a versioned snapshot. You can expose multiple versions simultaneously and let readers switch between them.

Blocks

Content is stored as structured blocks (headings, paragraphs, code, tables, callouts) rather than raw markdown. This enables rich editing, search indexing, and AI re-generation without loss of formatting.

Sync Engine

The sync engine listens for webhook events from your Git provider. On each push, it diffs only the changed files and updates the affected doc pages, keeping build times fast even in large repos.