CI/CD Integration

Automate your documentation deployment so docs are always published on every merge to main.

GitHub Actions

yaml

name: Publish Docs
on: { push: { branches: [main] } }
jobs:
  publish:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: hyperdocs/deploy-action@v2
        with: { api-key: "${{ secrets.HYPERDOCS_KEY }}" }

GitLab CI

yaml

deploy-docs:
  stage: deploy
  only: [main]
  script:
    - npm install -g @hyperdocs/cli
    - hyperdocs deploy