# 2fd/graphdoc

Static page generator for documenting GraphQL Schema

Repository: https://github.com/2fd/graphdoc
Canonical: https://ross.abutalabs.com/products/graphdoc
Homepage: https://2fd.github.io/graphdoc
Language: TypeScript
License: MIT
License Family: permissive
Topics: graphql, documentation, documentation-tool, documentation-generator
Last push: 2023-01-31T01:32:39+00:00

## Health v2 (maintenance only)
Score: 32/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 35, longevity 100
- inputs: {"age_days": 3677, "days_push": 1311, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: no_releases
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 1563, forks 132 (observed 2026-08-28T04:05:04.029405+00:00)

## What it is
graphdoc is a command-line tool that generates static HTML documentation pages from GraphQL schemas. It accepts schemas from live endpoints, IDL files, introspection JSON, or modularized schema files, and supports custom plugins and templates.

## Use cases
- generate static documentation for a GraphQL schema
- document a GraphQL API from a live endpoint
- turn a schema.graphql IDL file into HTML docs
- publish GraphQL schema reference pages
- document a GraphQL schema from an introspection JSON file
- customize GraphQL docs with plugins and templates

## When to choose
- you need static, hostable HTML docs for a GraphQL schema
- you want to generate docs from an endpoint, IDL, or introspection JSON
- you prefer a simple CLI with plugin/template support

## When to avoid
- you need live, interactive API exploration like GraphiQL
- you document non-GraphQL APIs
- you need actively maintained tooling with recent updates

## Facets
- artifact type: cli-tool
- maturity: maintenance
- function: documentation, api-documentation, static-site-generator, cli
- domain: documentation, developer-tools, apis
- platform: cli, cross-platform
- tags: graphql-schema, docs-generator, static-pages, graphql, nodejs

## Member repositories
- 2fd/graphdoc (main) score 32

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:05:04.029405+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-30T04:00:14.711097+00:00, confidence not recorded.
  - readme: https://github.com/2fd/graphdoc (fetched 2026-08-28T04:05:04.029405+00:00, sha d84cba9ab6a4)
  - homepage: https://2fd.github.io/graphdoc (fetched 2026-08-29T11:29:10.049918+00:00, sha a14645ac270c)
- Data as of 2026-08-30T08:39:29.467469+00:00.