Configuration

Configure your RepoDocs project settings

Configuration

RepoDocs is designed to work with zero configuration, but you can customize various settings.

Project Settings

Access settings from your dashboard: Dashboard → Project → Settings

General

Setting Description Default
Project Name Display name Repository name
URL Slug URL path Repository name
Branch Git branch to use main
Docs Path Folder containing docs /docs

Custom Domain

Connect your own domain:

  1. Add your domain in settings
  2. Create a CNAME record pointing to repodocs.dev
  3. Wait for DNS propagation (up to 24h)
  4. SSL certificate is auto-provisioned

Environment Variables

For self-hosted deployments:

Docker Deployment

Start with:

Webhook Configuration

RepoDocs automatically creates a webhook when you add a project. If you need to set it up manually:

  1. Go to your repo → Settings → Webhooks
  2. Add webhook URL: https://your-domain/api/webhook/github
  3. Content type: application/json
  4. Secret: Use the same as GITHUB_WEBHOOK_SECRET
  5. Events: Select "Push events"