magidoc VS dociql

Magidoc is a fully-free open source static documentation generator for GraphQL. Whether you want to get visibility on internal APIs or document public endpoints for your customers, Magidoc can do it all! If you're interested in learning more, come see our repo!

Indexing code

It depends on what you're trying to do with your blog. In Magidoc, this engine is used to take external markdown (provided by files or a GraphQL schema for instance) and convert it to html to build a static website. This kind of library is more adapted for this kind of use-case where the markdown is provided externally.

I'm asking because have an issue in my project in which I would like to implement such search. It is a relatively complicated feature, and one of the main thing is that I would like the site to be pre-indexed. Which means that the index should be created at build time, and not when you open the page. Is it what you did in your project?

Repo: https://github.com/magidoc-org/magidoc/tree/main/packages/starters/carbon-multi-page

Depends what you are looking to do with the documentation, but there are a few tools to generate static documentation. I personally built an open source tool to generate GraphQL documentation that we use in my company. It's called Magidoc, you can see the repo here, .

Building a templates means that you are free to choose the design of the website, but also that you can implement the template in Svelte! There is a contributing guide to help you get started with the project.

If you are not interested in contributing but the project interests you, you can still support Magidoc by leaving a ⭐ on Github!

Magidoc is a GraphQL documentation generator

SpectaQL was originally forked from a project called DociQL to add some enhancements there. And DociQL was originally forked from a project called Spectacle to make it work with GraphQL. And (finally) Spectacle was designed to work with Swagger/OpenAPI. Swagger/OpenAPI is a specification designed to help standardize the description of REST APIs with many routes, and uses JSON Schema as the way to define Data Types/Models. This means that SpectaQL had to wrestle with several layers of history and transformations; making SpectaQL's enhancements fit into the DociQL world, which in turn had to make things fit into the Spectacle/Swagger/OpenAPI world.

There was one solution we found that was the closest to what we were looking for: DociQL. It's an open-source, node.js project that describes itself like this: "DociQL generates beautiful static HTML5 documentation from a GraphQL endpoint using the introspection query." Awesome!