Introduction

Hyperdocs is an AI-powered documentation platform that automatically generates, syncs, and publishes beautiful docs from your codebase. Whether you are a solo developer or a team of hundreds, Hyperdocs keeps your documentation always up to date — without any manual effort.

Traditional documentation workflows break down quickly. Docs live in a separate repo, get out of sync with the code, and nobody has time to update them. Hyperdocs solves this by treating documentation as a first-class output of your development process.

Key Features

•Auto-generate docs from source code, comments, and OpenAPI specs using AI

•Real-time sync with GitHub, GitLab, and Bitbucket on every push

•Rich block editor — headings, code, tables, callouts, images

•Versioned docs with full history and diff viewer

•Custom domains with automatic SSL provisioning

•Full-text search powered by a dedicated indexing engine

•Access controls — public, private, or password-protected docs

•REST API and SDKs for JavaScript, Python, and Go

How It Works

Hyperdocs connects directly to your repository via a lightweight webhook. On every push to your configured branch, the sync engine diffs only the changed files and updates the affected doc pages. No full rebuilds — even large monorepos stay fast.

The AI layer reads your source code, inline comments, JSDoc/TSDoc annotations, and any existing markdown files. It structures this into a navigable doc site with sections, headings, and code examples already in place. You can then edit, rearrange, or extend any part of the output.

Architecture Overview

At a high level, Hyperdocs consists of four layers:

1.Ingestion — your repo is cloned and parsed on each sync event

1.AI Generation — changed files are sent to the generation pipeline which produces structured blocks

1.Storage — blocks are stored in a versioned content graph, not raw markdown

1.Delivery — the rendered docs site is served via a global CDN with sub-50ms TTFB

Supported Stacks

Hyperdocs parses documentation from a wide range of languages and frameworks out of the box:

Language	Comment Style	Extras
TypeScript / JavaScript	JSDoc, TSDoc	OpenAPI v3, GraphQL SDL
Python	Docstrings (Google, NumPy)	FastAPI auto-schema
Go	GoDoc comments	go doc output
Rust	rustdoc (///)	cargo doc output
Java / Kotlin	Javadoc, KDoc	Spring annotations

Quick Example

Here is all it takes to publish your first docs site:

bash

# 1. Install the CLI
npm install -g @hyperdocs/cli

# 2. Authenticate
hyperdocs login

# 3. Initialise a project in your repo root
hyperdocs init

# 4. Generate docs from source
hyperdocs generate

# 5. Publish
hyperdocs deploy

Pricing

Hyperdocs is free for open-source projects and individual developers. Paid plans unlock private docs, custom domains, team access controls, and priority support.

Plan	Price	Projects	Team Members
Free	$0 / mo	3	1
Pro	$19 / mo	Unlimited	5
Team	$49 / mo	Unlimited	25
Enterprise	Custom	Unlimited	Unlimited

Security

All data is encrypted at rest (AES-256) and in transit (TLS 1.3). API keys are hashed with bcrypt and never stored in plaintext. Hyperdocs is SOC 2 Type II certified and GDPR compliant.

We never store your source code beyond the time needed to generate documentation. Parsed ASTs are discarded after each sync.

Callout Examples

Callouts help highlight important information at a glance.

Your API key has been verified and your account is ready to use.

Hyperdocs supports OpenAPI v3, GraphQL SDL, and AsyncAPI out of the box.

Rate limits are applied per API key, not per IP address.

Use the hyperdocs generate --watch flag during development to auto-regenerate docs on file changes.

Rotating your API key will immediately invalidate the old key. Update all integrations before rotating.

Deleting a project is permanent and cannot be undone. All pages, history, and settings will be lost.

Getting Help

We are here to help. Choose the channel that works best for you:

•GitHub Issues — bug reports and feature requests

•Discord — real-time community support

•Email support@hyperdocs.io — Pro and Enterprise customers

If you run into issues, open a GitHub issue or reach out on Discord. We respond within 24 hours.