https://github.com/launchport/graphdoc

Generate beautiful documentantion for your/any GraphQL API in an instant ✨
https://github.com/launchport/graphdoc

documentation documentation-generator generator graphql

Last synced: about 1 month ago
JSON representation

Generate beautiful documentantion for your/any GraphQL API in an instant ✨

• Host: GitHub
• URL: https://github.com/launchport/graphdoc
• Owner: launchport
• Created: 2022-03-25T09:17:56.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2022-04-23T11:35:33.000Z (over 2 years ago)
• Last Synced: 2024-08-07T08:08:00.129Z (5 months ago)
• Topics: documentation, documentation-generator, generator, graphql
• Homepage: https://graphdoc.io
• Size: 4.88 KB
• Stars: 32
• Watchers: 2
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        


**Instant, beautiful docs for your GraphQL API**

---

## Providing a custom configuration

GraphDoc will check for a the existence of `.well-known/graphql.json` file on the same domain as your GraphQL API. So if your API runs on `https://api.example.com/graphql` the config will be expected at `https://api.example.com/.well-known/graphql.json`.

### Example configuration

```json

{

  "title": "My GraphQL API",

  "description": "Awesome API that provides a ton of value.",

  "favicon_url": "http://static.example.com/favicon.ico",

  "logo_light_url": "http://static.example.com/logo-light.svg",

  "logo_dark_url": "http://static.example.com/logo-dark.svg",

  "headers": {

    "Authorization": "Bearer MyPublicSecret"

  }

}

```

## Issues

If you have any issues regarding rendering your GraphQL API, [don't hesitate to report it here](https://github.com/launchport/graphdoc/issues).