{"id":47577487,"url":"https://github.com/sourcey/sourcey","last_synced_at":"2026-04-05T14:00:45.606Z","repository":{"id":4916086,"uuid":"49493043","full_name":"sourcey/sourcey","owner":"sourcey","description":"Beautiful static documentation generator for OpenAPI/Swagger 2.0","archived":false,"fork":false,"pushed_at":"2026-03-26T23:07:50.000Z","size":2509,"stargazers_count":1280,"open_issues_count":36,"forks_count":324,"subscribers_count":14,"default_branch":"main","last_synced_at":"2026-03-27T11:08:03.356Z","etag":null,"topics":["api-documentation","developer-tools","docs","documentation","doxygen","openapi","openapi3","static-site-generator","typescript"],"latest_commit_sha":null,"homepage":"https://sourcey.com","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/sourcey.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":"ROADMAP.md","authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2016-01-12T10:36:11.000Z","updated_at":"2026-03-26T23:07:53.000Z","dependencies_parsed_at":"2024-06-18T15:20:31.972Z","dependency_job_id":"884c288f-b9a9-4f42-a8f6-4c423ab5e65c","html_url":"https://github.com/sourcey/sourcey","commit_stats":{"total_commits":214,"total_committers":42,"mean_commits":5.095238095238095,"dds":0.6448598130841121,"last_synced_commit":"3257da500b8a2483b6ad3356e50fe00b65bb6a6f"},"previous_names":["sourcey/sourcey"],"tags_count":11,"template":false,"template_full_name":null,"purl":"pkg:github/sourcey/sourcey","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fsourcey","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fsourcey/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fsourcey/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fsourcey/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/sourcey","download_url":"https://codeload.github.com/sourcey/sourcey/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/sourcey%2Fsourcey/sbom","scorecard":{"id":839487,"data":{"date":"2025-08-11","repo":{"name":"github.com/sourcey/spectacle","commit":"3257da500b8a2483b6ad3356e50fe00b65bb6a6f"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":2.4,"checks":[{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Dangerous-Workflow","score":-1,"reason":"no workflows found","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Token-Permissions","score":-1,"reason":"No tokens found","details":null,"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"Code-Review","score":7,"reason":"Found 6/8 approved changesets -- score normalized to 7","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"License","score":9,"reason":"license file detected","details":["Info: project has a license file: LICENSE:0","Warn: project license file does not contain an FSF or OSI license."],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: containerImage not pinned by hash: Dockerfile:1: pin your Docker image by updating node:8-alpine to node:8-alpine@sha256:38f7bf07ffd72ac612ec8c829cb20ad416518dbb679768d7733c93175453f4d4","Warn: npmCommand not pinned by hash: Dockerfile:11","Info:   0 out of   1 npmCommand dependencies pinned","Info:   0 out of   1 containerImage dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Branch-Protection","score":0,"reason":"branch protection not enabled on development/release branches","details":["Warn: branch protection not enabled for branch 'master'"],"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 28 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}},{"name":"Vulnerabilities","score":0,"reason":"51 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: GHSA-93q8-gq69-wqmw","Warn: Project is vulnerable to: GHSA-fwr7-v2mv-hh25","Warn: Project is vulnerable to: GHSA-v6h2-p8h4-qcjw","Warn: Project is vulnerable to: GHSA-grv7-fg5c-xmjg","Warn: Project is vulnerable to: GHSA-h452-7996-h45h","Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275","Warn: Project is vulnerable to: GHSA-fjxv-7rqg-78g4","Warn: Project is vulnerable to: GHSA-4q6p-r6v2-jvc5","Warn: Project is vulnerable to: GHSA-j383-35pm-c5h4","Warn: Project is vulnerable to: GHSA-rm36-94g8-835r","Warn: Project is vulnerable to: GHSA-896r-f27r-55mw","Warn: Project is vulnerable to: GHSA-jf85-cpcp-j695","Warn: Project is vulnerable to: GHSA-fvqr-27wr-82fm","Warn: Project is vulnerable to: GHSA-4xc9-xhrj-v574","Warn: Project is vulnerable to: GHSA-x5rq-j2xg-h7qm","Warn: Project is vulnerable to: GHSA-29mw-wpgm-hmr9","Warn: Project is vulnerable to: GHSA-35jh-r3h4-6jhm","Warn: Project is vulnerable to: GHSA-2m96-9w4j-wgv7","Warn: Project is vulnerable to: GHSA-h726-x36v-rx45","Warn: Project is vulnerable to: GHSA-5v2h-r2cx-5xgj","Warn: Project is vulnerable to: GHSA-rrrm-qjm4-v8hf","Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv","Warn: Project is vulnerable to: GHSA-hxm2-r34f-qmc5","Warn: Project is vulnerable to: GHSA-f8q6-p94x-37v3","Warn: Project is vulnerable to: GHSA-xvch-5gv4-984h","Warn: Project is vulnerable to: GHSA-qrpm-p2h7-hrv2","Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55","Warn: Project is vulnerable to: GHSA-r8f7-9pfq-mjmv","Warn: Project is vulnerable to: GHSA-rp65-9cf3-cjxr","Warn: Project is vulnerable to: GHSA-76c9-3jph-rj3q","Warn: Project is vulnerable to: GHSA-566m-qj78-rww5","Warn: Project is vulnerable to: GHSA-7fh5-64p2-3v2j","Warn: Project is vulnerable to: GHSA-hrpp-h998-j3pp","Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6","Warn: Project is vulnerable to: GHSA-7mwh-4pqv-wmr8","Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw","Warn: Project is vulnerable to: GHSA-m6fv-jmcg-4jfg","Warn: Project is vulnerable to: GHSA-76p7-773f-r4q5","Warn: Project is vulnerable to: GHSA-cm22-4g7w-348p","Warn: Project is vulnerable to: GHSA-4rq4-32rv-6wp6","Warn: Project is vulnerable to: GHSA-64g7-mvw6-v9qj","Warn: Project is vulnerable to: GHSA-3jfq-g458-7qm9","Warn: Project is vulnerable to: GHSA-r628-mhmh-qjhw","Warn: Project is vulnerable to: GHSA-9r2w-394v-53qc","Warn: Project is vulnerable to: GHSA-5955-9wpr-37jh","Warn: Project is vulnerable to: GHSA-qq89-hq3f-393p","Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36","Warn: Project is vulnerable to: GHSA-52f5-9888-hmc6","Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3","Warn: Project is vulnerable to: GHSA-v2p6-4mp7-3r9v","Warn: Project is vulnerable to: GHSA-3h5v-q93c-6h6q"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}}]},"last_synced_at":"2025-08-23T20:06:10.245Z","repository_id":4916086,"created_at":"2025-08-23T20:06:10.245Z","updated_at":"2025-08-23T20:06:10.245Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":31437927,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-04-05T13:13:19.330Z","status":"ssl_error","status_checked_at":"2026-04-05T13:13:17.778Z","response_time":75,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api-documentation","developer-tools","docs","documentation","doxygen","openapi","openapi3","static-site-generator","typescript"],"created_at":"2026-03-31T06:00:36.085Z","updated_at":"2026-04-05T14:00:45.600Z","avatar_url":"https://github.com/sourcey.png","language":"TypeScript","funding_links":[],"categories":["TypeScript","OpenAPI Utilities"],"sub_categories":[],"readme":"# Sourcey\n\n\u003e Your API docs shouldn't depend on someone else's SaaS.\n\nSourcey is an open source documentation platform. Point it at an OpenAPI spec, add markdown guides, get a complete docs site. Static HTML you own; no dashboard, no monthly bill, no API calls to render your own documentation. Deploy anywhere.\n\n[![npm](https://img.shields.io/npm/v/sourcey)](https://www.npmjs.com/package/sourcey)\n[![build](https://img.shields.io/github/actions/workflow/status/sourcey/sourcey/ci.yml?branch=master)](https://github.com/sourcey/sourcey/actions)\n[![node](https://img.shields.io/node/v/sourcey)](https://nodejs.org)\n\n```bash\nnpx sourcey init\n```\n\n![Sourcey](assets/screenshot.jpg)\n\n**[Live demo](https://cheesestore.github.io/)** · [Documentation](https://sourcey.com/docs) · [GitHub](https://github.com/sourcey/sourcey)\n\n## Features\n\n- **API reference from OpenAPI** — endpoints, parameters, request/response schemas, auto-generated code samples in 10 languages (cURL, JavaScript, TypeScript, Python, Go, Ruby, Java, PHP, Rust, C#)\n- **Markdown guides with rich components** — steps, cards, accordions, syntax-highlighted code blocks; everything you need for prose docs alongside your API reference\n- **TypeScript config** — `sourcey.config.ts` with `defineConfig()` autocomplete; theme, navbar, CTA buttons, footer\n- **Theme presets** — default (sidebar + TOC), minimal (single column), api-first (Stripe-style three column); colors, fonts, layout dimensions, and custom CSS on top\n- **Vite dev server** — SSR hot reload on every component and CSS change; spec and markdown changes trigger instant refresh\n- **Dark mode** — semantic design tokens, light/dark logo variants, localStorage persistence\n- **Client-side search** — instant fuzzy search across all pages and API operations\n- **Static HTML output** — no framework runtime, no vendor lock-in. Deploy to GitHub Pages, Vercel, Netlify, S3, anywhere\n- **Open source** — AGPL-3.0. Self-host, fork, extend. Your docs, your infrastructure\n\n### Sourcey vs alternatives\n\n| | Sourcey | Mintlify | GitBook | Fern | Redocly | VitePress |\n|---|---|---|---|---|---|---|\n| OpenAPI reference | Native | Native | No | Native | Native | Plugin |\n| Markdown guides | Native | Native | Native | Native | Native | Native |\n| Static output you own | Yes | No | No | No | Yes | Yes |\n| Zero JS shipped | Yes | No | No | No | No | No (Vue SPA) |\n| TypeScript config | Yes | JSON | GUI | YAML | YAML | TS |\n| Hot reload dev server | Vite SSR | Cloud | Cloud | Cloud | Webpack | Vite SPA |\n| Rich components | Yes | Yes | Limited | Yes | No | Vue |\n| Theme presets | Yes | No | No | No | No | Yes |\n| Self-hosted | Yes | No | No | No | Yes | Yes |\n| Pricing | Free / AGPL | $150+/mo | Free / paid | Paid | Free / paid | Free |\n\n## Install\n\n```bash\n# npm (recommended)\nnpx sourcey init\n\n# Homebrew\nbrew tap sourcey/sourcey \u0026\u0026 brew install sourcey\n\n# Docker\ndocker run -v $(pwd):/docs sourcey/sourcey build\n\n# Nix\nnix run github:sourcey/sourcey\n```\n\n## Quick start\n\n```bash\n# From a single OpenAPI spec\nsourcey build api.yaml -o docs/\n\n# Multi-page site (reads sourcey.config.ts)\nsourcey build -o docs/\n\n# Dev server with hot reload\nsourcey dev\n```\n\n## Configuration\n\nCreate `sourcey.config.ts` in your project root:\n\n```typescript\nimport { defineConfig } from \"sourcey\";\n\nexport default defineConfig({\n  name: \"My API\",\n  theme: {\n    preset: \"default\",  // \"default\" | \"minimal\" | \"api-first\"\n    colors: {\n      primary: \"#6366F1\",\n      light: \"#818CF8\",\n      dark: \"#4F46E5\",\n    },\n  },\n  logo: \"./logo.png\",\n  navigation: {\n    tabs: [\n      {\n        tab: \"Documentation\",\n        groups: [\n          {\n            group: \"Getting Started\",\n            pages: [\"introduction\", \"quickstart\", \"authentication\"],\n          },\n        ],\n      },\n      {\n        tab: \"API Reference\",\n        openapi: \"./openapi.yaml\",\n      },\n    ],\n  },\n  navbar: {\n    links: [{ type: \"github\", href: \"https://github.com/you/repo\" }],\n    primary: { type: \"button\", label: \"Dashboard\", href: \"https://app.example.com\" },\n  },\n  footer: {\n    socials: { github: \"https://github.com/you/repo\" },\n  },\n});\n```\n\nEach tab is either an `openapi` spec or `groups` of markdown pages. Pages are referenced by slug (e.g. `\"quickstart\"` resolves to `quickstart.md`).\n\n### Markdown components\n\nGuides support rich components in standard markdown:\n\n```markdown\n\u003cSteps\u003e\n  \u003cStep title=\"Install\"\u003eRun `npm install sourcey`\u003c/Step\u003e\n  \u003cStep title=\"Configure\"\u003eCreate `sourcey.config.ts`\u003c/Step\u003e\n  \u003cStep title=\"Build\"\u003eRun `sourcey build`\u003c/Step\u003e\n\u003c/Steps\u003e\n\n\u003cCardGroup cols={2}\u003e\n  \u003cCard title=\"API Reference\" icon=\"book\" href=\"/api\"\u003eFull endpoint docs\u003c/Card\u003e\n  \u003cCard title=\"Guides\" icon=\"map\" href=\"/docs\"\u003eStep-by-step tutorials\u003c/Card\u003e\n\u003c/CardGroup\u003e\n\n\u003cAccordionGroup\u003e\n  \u003cAccordion title=\"How does auth work?\"\u003eWe use API keys and OAuth2.\u003c/Accordion\u003e\n\u003c/AccordionGroup\u003e\n```\n\n### Theme\n\nAll visual configuration lives under `theme`. Colors, fonts, layout dimensions, and a preset that controls page structure:\n\n```typescript\ntheme: {\n  preset: \"api-first\",\n  colors: { primary: \"#f59e0b\", light: \"#fbbf24\", dark: \"#d97706\" },\n  fonts: { sans: \"'Lexend', sans-serif\", mono: \"'Fira Code', monospace\" },\n  layout: { sidebar: \"16rem\", content: \"48rem\" },\n  css: [\"./brand.css\"],\n}\n```\n\nPresets control layout structure: `\"default\"` (sidebar + TOC), `\"minimal\"` (single centered column), `\"api-first\"` (three-column with persistent code panels). Everything else applies on top.\n\n## CLI\n\n```bash\nsourcey dev                       Dev server (reads sourcey.config.ts)\nsourcey build                     Build site (reads sourcey.config.ts)\nsourcey build api.yaml            Quick build from a single spec\nsourcey validate api.yaml         Validate a spec file\n```\n\n| Command | Flag | Description |\n| --- | --- | --- |\n| `build` | `--output, -o` | Output directory (default: `dist`) |\n| `build` | `--embed, -e` | Embeddable output (no html/body wrapper) |\n| `build` | `--quiet, -q` | Suppress output |\n| `dev` | `--port, -p` | Dev server port (default: `4400`) |\n\n## Development\n\n```bash\ngit clone https://github.com/sourcey/sourcey.git\ncd sourcey \u0026\u0026 npm install\nnpm run build \u0026\u0026 npm test\n\n# Run the demo site\ncd demo \u0026\u0026 npx tsx ../src/cli.ts dev\n```\n\n## License\n\n[AGPL-3.0](LICENSE). Free to use, self-host, and modify. If you run Sourcey as a hosted service, you open-source your stack.\n\nCommercial licensing available; contact [sourcey.com](https://sourcey.com).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcey%2Fsourcey","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsourcey%2Fsourcey","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsourcey%2Fsourcey/lists"}