{"id":19894534,"url":"https://github.com/stepzen-dev/stepzen-spectaql-docs","last_synced_at":"2026-05-30T23:31:26.978Z","repository":{"id":97527153,"uuid":"410867084","full_name":"stepzen-dev/stepzen-spectaql-docs","owner":"stepzen-dev","description":"Create static documentation for your GraphQL with StepZen and SpectaQL!","archived":false,"fork":false,"pushed_at":"2021-10-27T13:00:10.000Z","size":24,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-25T11:50:41.753Z","etag":null,"topics":["documentation","graphql","spectaql","stepzen"],"latest_commit_sha":null,"homepage":"https://stepzen.com/blog/creating-static-documentation-for-graphql-apis-using-graphql-sdl","language":"HTML","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/stepzen-dev.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2021-09-27T12:02:28.000Z","updated_at":"2022-11-01T04:36:46.000Z","dependencies_parsed_at":null,"dependency_job_id":"651b347d-10c7-4d28-9383-5ca2d73f5194","html_url":"https://github.com/stepzen-dev/stepzen-spectaql-docs","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/stepzen-dev/stepzen-spectaql-docs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepzen-dev%2Fstepzen-spectaql-docs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepzen-dev%2Fstepzen-spectaql-docs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepzen-dev%2Fstepzen-spectaql-docs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepzen-dev%2Fstepzen-spectaql-docs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/stepzen-dev","download_url":"https://codeload.github.com/stepzen-dev/stepzen-spectaql-docs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/stepzen-dev%2Fstepzen-spectaql-docs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":33714033,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-05-30T02:00:06.278Z","response_time":92,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"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":["documentation","graphql","spectaql","stepzen"],"created_at":"2024-11-12T18:33:48.381Z","updated_at":"2026-05-30T23:31:26.960Z","avatar_url":"https://github.com/stepzen-dev.png","language":"HTML","funding_links":[],"categories":[],"sub_categories":[],"readme":"# stepzen-spectaql-docs\n\nCreate static documentation for your GraphQL with [StepZen](https://stepzen.com/) and [SpectaQL](https://github.com/anvilco/spectaql)! You can find a full explanation of how to do this by reading the article [Creating Static Documentation For GraphQL APIs Using GraphQL SDL\n](https://stepzen.com/blog/creating-static-documentation-for-graphql-apis-using-graphql-sdl).\n\n## Getting started\n\nBefore you get started, you'll need to get yourself a [StepZen account](https://stepzen.com/request-invite) and install the [StepZen CLI](https://stepzen.com/docs/quick-start).\n\nAfter creating an account you can clone the repository and move into the newly created directory on your local machine. Here you must start the GraphQL server by running `stepzen start`. This will make a GraphQL server with the GraphQL schemas from this repository. Make sure to replace the variables `stepzen_api_endpoint` and `stepzen_api_key` with your own.  \n\nTo create the documentation you must run `npx spectaql -D config.yml` to create the static documentation with SpectaQL based on the StepZen GraphQL API and the SpectaQL configuration in `config.yml`. The output will be a static website that you can find in the `public` directory.\n\n\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstepzen-dev%2Fstepzen-spectaql-docs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fstepzen-dev%2Fstepzen-spectaql-docs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fstepzen-dev%2Fstepzen-spectaql-docs/lists"}