April 2024

Graphinx

Graphinx

A library to generate beautiful and interactive documentation sites for GraphQL APIs. Initially made for Churros

The name comes from a portmanteau of GraphQL, and Sphinx, a popular documentation site generator for Python libraries

The idea of Graphinx is to keep the API up to date by using the source code of the API server as much as possible, alongside the GraphQL descriptions, and to categorize all items in modules, as large GraphQL APIs that have auto-generated documentation sites tend to be single-page, difficult-to-navigate dumps of all types, sorted alphabetically, which is less than ideal (see for example, Github’s GraphQL API documentation).

Technical documentation
github.com
On Github
github.com

Time spent

65 hours 16 minutes

made with

  • CSS
  • HTML
  • TypeScript
  • Svelte
  • TypeScript
  • GraphQL
  • Bun