magidoc-org / magidoc

Autogenerate static GraphQL API documentation
https://magidoc.js.org
MIT License
250 stars 21 forks source link
documentation documentation-generator graphql javascript markdown marked marked-js node nodejs-library prismjs svelte sveltekit typescript typescript-library

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

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.

License

MIT