Deployment

Deploy your documentation site using the Hyperdocs CLI or connect your CI/CD pipeline for automatic publishing on every push.

Using the CLI

bash

npx hyperdocs deploy --env production

GitHub Actions

yaml

name: Deploy Docs
on:
  push:
    branches: [main]
jobs:
  deploy:
    runs-on: ubuntu-latest
    steps:
      - uses: hyperdocs/deploy-action@v2
        with:
          api-key: ${{ secrets.HYPERDOCS_API_KEY }}

Environment Variables

Variable	Required	Description
HYPERDOCS_API_KEY	Yes	Your API key
HYPERDOCS_PROJECT_ID	Yes	Your project ID