Skip to content

Update README.md

Update README.md #4

Workflow file for this run

name: Deploy docmd site to GitHub Pages
on:
push:
branches: [main]
workflow_dispatch:
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment; cancel in-progress runs for the same ref.
concurrency:
group: pages
cancel-in-progress: true
jobs:
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v4
with:
# Full history so the git plugin can compute accurate "last updated" dates.
fetch-depth: 0
- name: Setup Node
uses: actions/setup-node@v4
with:
node-version: 20
- name: Determine base path
id: base
run: |
REPO="${{ github.event.repository.name }}"
# A custom domain (CNAME present) serves at the domain root → base "/".
# User/org pages (<name>.github.io) also serve at root.
# Project pages serve under /<repo>/. docmd reads this via DOCMD_PROJECT_PREFIX.
if [[ -f CNAME ]]; then
echo "prefix=/" >> "$GITHUB_OUTPUT"
elif [[ "$REPO" == *.github.io ]]; then
echo "prefix=/" >> "$GITHUB_OUTPUT"
else
echo "prefix=/$REPO/" >> "$GITHUB_OUTPUT"
fi
- name: Install dependencies
run: npm install
- name: Build site
env:
DOCMD_PROJECT_PREFIX: ${{ steps.base.outputs.prefix }}
run: npx @docmd/core build
- name: Preserve custom domain (CNAME)
run: if [ -f CNAME ]; then cp CNAME site/CNAME; fi
- name: Configure Pages
uses: actions/configure-pages@v5
- name: Upload artifact
uses: actions/upload-pages-artifact@v3
with:
path: site
deploy:
needs: build
runs-on: ubuntu-latest
environment:
name: github-pages
url: ${{ steps.deployment.outputs.page_url }}
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v4