https://github.com/magidoc-org/magidoc

Autogenerate static GraphQL API documentation
https://github.com/magidoc-org/magidoc

documentation documentation-generator graphql javascript markdown marked marked-js node nodejs-library prismjs svelte sveltekit typescript typescript-library

Last synced: 7 days ago
JSON representation

Autogenerate static GraphQL API documentation

• Host: GitHub
• URL: https://github.com/magidoc-org/magidoc
• Owner: magidoc-org
• License: mit
• Created: 2022-02-05T12:11:44.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2024-12-01T22:47:58.000Z (11 days ago)
• Last Synced: 2024-12-02T08:12:57.761Z (11 days ago)
• Topics: documentation, documentation-generator, graphql, javascript, markdown, marked, marked-js, node, nodejs-library, prismjs, svelte, sveltekit, typescript, typescript-library
• Language: TypeScript
• Homepage: https://magidoc.js.org
• Size: 16.3 MB
• Stars: 254
• Watchers: 3
• Forks: 21
• Open Issues: 24
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md
  • Security: SECURITY.md

Awesome Lists containing this project

• awesome-documentation - Magidoc - A a JavaScript library that auto-generates static documentation from any GraphQL schema. (Documentation Types / API Documentation)

README

        


  



Fast and customizable GraphQL documentation generator 




  

  

  

  

  

  



  

---


Magidoc is a JavaScript library that auto-generates static documentation from any [GraphQL](https://graphql.org/) 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.

- 🔎 **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.

## Get started

See the [quickstart guide](https://magidoc.js.org/introduction/quickstart).

## Demo

👉 See the [demo website](https://magidoc-carbon-multi-page.netlify.app) generated from SpaceX's public [GraphQL API](https://spacex-production.up.railway.app/).

## Documentation

Full documentation and options are available at [magidoc.js.org](https://magidoc.js.org/introduction/welcome).

## Examples

Examples to generate documentation simply for one or even for multiple schemas are available [right here](./packages/examples/).

## Contribution

See the [contribution guide](./CONTRIBUTING.md).

## License

[MIT](./LICENSE)