The most robust and automated way to deploy to GitHub Pages is using a GitHub Actions workflow. This ensures your site rebuilds automatically every time you push changes to your repository.

1. Create the Workflow File
Create a file in your repository at .github/workflows/deploy-docs.yml and add the following content:

name: Deploy docmd to GitHub Pages

on:
  push:
    branches: ["main"] # Change this if your default branch is 'master'
  workflow_dispatch:   # Allows manual triggers

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

jobs:
  build-and-deploy:
    runs-on: ubuntu-latest
    environment:
      name: github-pages
      url: ${{ steps.deployment.outputs.page_url }}
    steps:
      - name: Checkout
        uses: actions/checkout@v4

      - name: Set up Node.js
        uses: actions/setup-node@v4
        with:
          node-version: '22' # docmd requires Node 18+
          cache: 'npm'

      - name: Install docmd
        run: npm install -g @docmd/core

      - name: Build site
        run: docmd build 

      - name: Setup Pages
        uses: actions/configure-pages@v5

      - name: Upload artifact
        uses: actions/upload-pages-artifact@v3
        with:
          path: ./site # Your configured outputDir

      - name: Deploy to GitHub Pages
        id: deployment
        uses: actions/deploy-pages@v4

2. Configure Repository Settings
Go to your repository settings on GitHub. Navigate to Pages, and under “Build and deployment”, change the Source to GitHub Actions.

The next time you push to your main branch, your docs will automatically build and publish!