Magidoc
Autogenerate static GraphQL API documentation
Overview
Magidoc is a JavaScript library that auto-generates static documentation from any GraphQL schema. It provides an easy and customizable way to document your API, with features such as fast search, live reloading, and advanced markdown support.
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.
- Svelte
Svelte is a modern front-end framework that compiles your code at build time, resulting in smaller and faster applications. It uses a reactive approach to update the DOM, allowing for high performance and a smoother user experience.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
- Graphql
A website that uses GraphQL as a query language to manage data fetching and state management. This includes features such as a strongly typed schema, client-side caching, and declarative data fetching to streamline data management and optimize website performance.
- Prism JS
PrismJS is an open-source, lightweight, and extensible syntax highlighting library that supports a wide range of programming languages and markup formats.
- Typescript
TypeScript is a superset of JavaScript, providing optional static typing, classes, interfaces, and other features that help developers write more maintainable and scalable code. TypeScript's static typing system can catch errors at compile-time, making it easier to build and maintain large applications.
