sagarkrsd / magidoc Goto Github PK

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.

• 🏁 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.

See the quickstart guide.

👉 See the demo website generated from FaunaDB's example GraphQL API.

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

Examples to generate documentation simply for one or even for multiple schemas are available right here.

See the contribution guide.

MIT