Build Docs with Sourcey

GitHub Action to build static documentation from OpenAPI specs and markdown using Sourcey.

Usage

- uses: sourcey/build-docs@v1with:
spec: openapi.yamloutput: docs

With a config file

- uses: sourcey/build-docs@v1

Sourcey auto-detects sourcey.config.ts in the repo root.

Deploy to GitHub Pages

name: Deploy Docson:
push:
branches: [main]permissions:
pages: writeid-token: writejobs:
build:
runs-on: ubuntu-lateststeps:
- uses: actions/checkout@v4
- uses: sourcey/build-docs@v1with:
output: docs
- uses: actions/upload-pages-artifact@v3with:
path: docs
- uses: actions/deploy-pages@v4

Inputs

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

Outputs

Output	Description
output-dir	Path to the generated documentation