GitHub Action to build static documentation from OpenAPI specs and markdown using Sourcey.
- uses: sourcey/build-docs@v1
with:
spec: openapi.yaml
output: docs- uses: sourcey/build-docs@v1Sourcey auto-detects sourcey.config.ts in the repo root.
name: Deploy Docs
on:
push:
branches: [main]
permissions:
pages: write
id-token: write
jobs:
build:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- uses: sourcey/build-docs@v1
with:
output: docs
- uses: actions/upload-pages-artifact@v3
with:
path: docs
- uses: actions/deploy-pages@v4| Input | Description | Default |
|---|---|---|
version |
Sourcey version to install | latest |
config |
Path to sourcey.config.ts | auto-detect |
spec |
Path to OpenAPI spec file | |
output |
Output directory | docs |
args |
Additional arguments |
| Output | Description |
|---|---|
output-dir |
Path to the generated documentation |