Deployment

Ship static HTML from Bengal to GitHub Pages, Netlify, Vercel, or any host that serves files from a directory.

Bengal generates static HTML, CSS, and JavaScript. Run a production build, upload thepublic/directory, and point your host at it.

The Production Build

When you are ready to ship, run the production build:

bengal build --environment production --strict --clean-output

Output goes to public/. Use --fastfor CI builds when you do not need verbose timing output.

This command:

• Loads configuration fromconfig/environments/production.yaml(if it exists)
• Minifies HTML output (enabled by default)
• Generates thepublic/directory with your complete site

Common Build Flags

Example full command for CI matches the snippet above — add--fastwhen you want maximum CI throughput with quiet output.

GitHub Pages

Deploy using GitHub Actions. Create.github/workflows/deploy.yml:

name: Deploy to GitHub Pages

on:
  push:
    branches: [main]

permissions:
  contents: read
  pages: write
  id-token: write

jobs:
  build:
    runs-on: ubuntu-latest
    steps:
      - uses: actions/checkout@v4

      - name: Set up Python
        uses: actions/setup-python@v5
        with:
          python-version: '3.14'

      - name: Install Bengal
        run: pip install bengal

      - name: Build Site
        run: bengal build --environment production --strict --clean-output

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: './public'

  deploy:
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    runs-on: ubuntu-latest
    needs: build
    steps:
      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

Netlify

Create anetlify.tomlin your repository root:

[build]
  publish = "public"
  command = "bengal build --environment production"

[build.environment]
  PYTHON_VERSION = "3.14"

Vercel

Configure your project:

1. Build Command:bengal build --environment production
2. Output Directory:public
3. Ensure yourrequirements.txt includes bengal.

Automatic Platform Detection

Bengal auto-detects your deployment platform and configuresbaseurlautomatically:

You can override auto-detection with theBENGAL_BASEURLenvironment variable:

BENGAL_BASEURL="https://custom-domain.com" bengal build --environment production

Pre-Deployment Checklist

Before you merge to main or deploy:

1. Runbengal config doctor: Checks for common configuration issues.
2. Runbengal build --strictlocally: Ensures no template errors.
3. Runbengal check: Runs health checks on your site content.
4. Checkconfig/environments/production.yaml: Ensure your baseurlis set to your production domain.

# config/environments/production.yaml
site:
  baseurl: "https://example.com"