Awesome
<p align="center"> <img width="40%" src="./logo/logo_full.png"> </p> <h3 align="center">Fast and customizable GraphQL documentation generator </h3> <p align="center"> <a href="https://www.npmjs.com/package/@magidoc/cli"><img src="https://img.shields.io/npm/v/@magidoc/cli" /></a> <a href="https://www.npmjs.com/package/@magidoc/cli"><img src="https://img.shields.io/npm/dw/@magidoc/cli" /></a> <a href="https://github.com/magidoc-org/magidoc/actions"><img src="https://img.shields.io/github/actions/workflow/status/magidoc-org/magidoc/build-and-tests.yml?branch=main" /></a> <a href="https://github.com/magidoc-org/magidoc/blob/main/LICENSE"><img src="https://img.shields.io/github/license/magidoc-org/magidoc" /></a> <a href="https://nodejs.org/en/about/releases/"><img src="https://img.shields.io/node/v/@magidoc/cli" /></a> <a href="https://app.codecov.io/gh/magidoc-org/magidoc"><img src="https://img.shields.io/codecov/c/github/magidoc-org/magidoc?label=coverage" /></a> </p>Magidoc is a JavaScript library that auto-generates static documentation from any GraphQL schema. By default, it automatically generates documentation for each query, mutation, subscription and type of your API.
Features
- 🏁 Simple: Build your first website in a few minutes.
- ✏️ Customizable: Use pre-defined customizations or pick a template and make it your own.
- 🔎 Searchability: Fast fuzzy search through the documentation & native SEO support.
- 🔥 Live hot-reload: Preview your documentation website while you develop.
- 📝 Advanced markdown support: Markdown is supported everywhere, from custom pages to schema comments.
Get started
See the quickstart guide.
Demo
👉 See the demo website generated from SpaceX's public GraphQL API.
Documentation
Full documentation and options are available at magidoc.js.org.
Examples
Examples to generate documentation simply for one or even for multiple schemas are available right here.
Contribution
See the contribution guide.