/magidoc

Fast and highly customizable static documentation generator for GraphQL APIs.

Primary LanguageTypeScriptMIT LicenseMIT

Fast and highly customizable GraphQL documentation generator


Magidoc is an open source static GraphQL documentation auto-generator that offers the best developer experience, is infinitely customizable and produces better documentation than existing solutions.

Features

  • 🏁 Simple - Build your first website in seconds.

  • ✏️ Customizable - Use pre-defined customizations or pick a template and make it your own.

  • 🔥 Live hot-reload - Magidoc offers a dev command that updates a preview of your website in real time when you write your documentation.

  • 📝 Advanced markdown support - Markdown is supported everywhere, from the custom pages and sections you can create, to the SDL comments inside your GraphQL schema.

  • 📦 Fully typed - Every plugin and template ships with TypeScript definitions out of the box.

👀 Demo

👉 See the live demo using FaunaDB's example GraphQL API.

📄 Documentation

Read the docs!