How do you create your reference documentation?


#1

The reference documentation for the GitHub GraphQL API looks great. Do you have your own process for transforming the schema into HTML, or do you use an existing library?


#2

Hi! We use https://github.com/gjtorikian/graphql-docs which was built by… me! Every ten minutes, we run a cron job that pings GET /graphql to grab the latest IDL. graphql-docs then generates static HTML from that IDL, if anything changed.

If you have any feedback or questions on it, please open them on that repository.


#3

Brilliant! The lib looks great. Thanks so much for the quick response.


#4

Great to know that the code that is used to generate the (attractive) GitHub docs is available as a project. The default styling for the project is nice but minimalist. What are the chances of GitHub’s releasing a renderer and templates that produce a styling a little closer to the actual GitHub docs?