carloswalterbr / magidoc

Fast and highly customizable static documentation generator for GraphQL APIs.

Home Page:https://magidoc-org.github.io/magidoc/introduction/welcome

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

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!

About

Fast and highly customizable static documentation generator for GraphQL APIs.

https://magidoc-org.github.io/magidoc/introduction/welcome

License:MIT License


Languages

Language:TypeScript 68.7%Language:Svelte 19.8%Language:JavaScript 6.3%Language:CSS 4.8%Language:HTML 0.3%Language:Shell 0.0%