Static hosting

Without auth, rapidoc build writes a plain static site to dist/. Host it anywhere that serves files.

npx rapidoc build                 # dist/
npx rapidoc build --out-dir public # another folder

Set site.url to the portal’s public URL, for canonical links and the sitemap. To host the portal in a folder of another site, put the folder in the URL (https://acme.com/developers): links are built with /developers in front, and you upload dist/ into that folder (Serving under a path).

name: Deploy portal
on:
  push:
    branches: [main]
permissions:
  contents: read
  pages: write
  id-token: write
jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4
      - uses: actions/setup-node@v4
        with:
          node-version: 22
      - run: npm ci
      - run: npx rapidoc validate
      - run: npx rapidoc build
      - uses: actions/upload-pages-artifact@v3
        with:
          path: dist
  deploy:
    needs: build
    runs-on: ubuntu-latest
    environment:
      name: github-pages
    steps:
      - uses: actions/deploy-pages@v4

The portal’s links start at /, so serve it from the root of a domain: a custom domain, or a <user>.github.io repository.

Copy dist/ to the server’s web root (Nginx, Apache, Caddy, S3 with CloudFront). Every page is a folder with an index.html, so the server needs no rewrite rules.

A static host can’t check who is reading. With auth and access, deploy with rapidoc serve instead.