magidoc

magidoc copied to clipboard

Fast and customizable GraphQL documentation generator

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.
• 🔥 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 FaunaDB's example GraphQL API.

Documentation

Full documentation and options are available at magidoc.js.org.

Contribution

See the contribution guide.

License

MIT