Public Templates
Copy-paste ready DocsCI configuration templates. No login required. All templates are CC0 / public domain — use them freely in any project.
GitHub Actions — DocsCI workflow
Drop-in GitHub Actions workflow for documentation CI. Runs on push and pull_request, archives docs, posts results as PR comments. Includes a snippet execution step and OpenAPI drift detection when configured.
docsci.yml — project configuration reference
Full docsci.yml configuration reference with all supported keys: snippet execution settings, network allowlist, OpenAPI drift detection, accessibility checks, copy linting, and notification rules.
GitLab CI — DocsCI pipeline
GitLab CI configuration for documentation testing with DocsCI. Uses a dedicated `docs` stage that runs after build. Supports merge request pipelines and posts findings as MR comments via the GitLab API.
pre-commit hook — local snippet checks
Run DocsCI checks locally before committing. Catches broken snippets and credential patterns before they reach CI. Requires pre-commit and a DOCSCI_TOKEN environment variable.
Quick start
Download the GitHub Actions template and add your DocsCI token to get started in 2 minutes:
# 1. Download the workflow mkdir -p .github/workflows curl -o .github/workflows/docsci.yml \ https://snippetci.com/templates/docsci-github-actions.yml # 2. Add your API token to GitHub repository secrets # Settings → Secrets → Actions → New repository secret # Name: DOCSCI_TOKEN # Value: (from https://snippetci.com/signup) # 3. Add the docsci.yml config to your repo root curl -o docsci.yml \ https://snippetci.com/templates/docsci.yml # 4. Commit and push — first CI run starts automatically git add .github/workflows/docsci.yml docsci.yml git commit -m "ci: add DocsCI documentation testing" git push