{"repo":"brettchalupa/graphql-docs","free":true,"listed":false,"github":"https://github.com/brettchalupa/graphql-docs","clone":"git clone https://github.com/brettchalupa/graphql-docs.git","description":"Easily generate beautiful documentation from your GraphQL schema.","language":"Ruby","stars":521,"topics":["graphql","documentation","ruby","good-first-issue"],"license":"MIT","category":"docs-static-sites","readme_excerpt":"GraphQLDocs Ruby library and CLI for easily generating beautiful documentation from your GraphQL schema. Key links: - Demo : https://graphql-docs.bcodes.me. - Ruby documentation : https://rubydoc.info/github/brettchalupa/graphql-docs.git/main. Installation Add the gem to your project with this command: Or install it yourself as: Usage GraphQLDocs provides two ways to serve your documentation: 1. Static Site Generator (SSG) - Pre-generate all HTML files (default) 2. Rack Application - Serve documentation dynamically on-demand Static Site Generation (SSG) GraphQLDocs can be used as a Ruby library to build the documentation website. Using it as a Ruby library allows for more control and using every supported option. Here's an example: GraphQLDocs also has a simplified CLI ( graphql-docs ) that gets installed with the gem: That will generate the output in the output dir. See all of the supported CLI options with: Rake Task GraphQLDocs includes a Rake task for integration with Rails applications and other Ruby projects that use Rake. This allows you to generate documentation as part of your build process or hook it into other Rake tasks. Basic Usage Using task arguments (recommended): Or using environment variables: Available Arguments Arguments are passed in order: [schema file, output dir, base url, delete output] 1. schema file - Path to GraphQL schema file (required) 2. output dir - Output directory (default: ./output/ ) 3. base url - Base URL for assets and links (default: ''","default_branch":null,"files":null,"tree":[],"storefront":"/r/brettchalupa","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/brettchalupa/graphql-docs/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}