magidoc VS flexsearch

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!

Full-text search is powered by FlexSearch and Nextra will index all of your pages at build time ⚡.

I have a web page that reads in various .md files and displays them as HTML. The app uses the marked library to convert the markdown into HTML for display. I create a flexsearch search index out of the raw text values from the documents (raw text is gathered using DOMParser over all HTML elements) so that user can search for keywords in the docs and get back a table of results. The order of operations and search index code looks like:

I am trying to get flexsearch (a lib written in js) up and running in a TS project and found a working example here. I downloaded the project and ran 'yarn add flexsearch' and also 'yarn add @/types/flexsearch' since I know that you need a special index.d.ts file to convert the JS to TS properly.... however the code errors out during the Index object creation with the message.

Try using a proper browser search like Lunr or Flexsearch

Current version of FlexSearch (0.7.2) is not typo tolerant, see https://github.com/nextapps-de/flexsearch/issues/118

Very nice! Seems to perform very well. I'm curious, have you compared Fuse with other search engines? Like flex search or elasticlunr? Why did you choose fuse ?

I actually looked into this term before localeCompare(): Full Text Search. It's pretty heavy duty. In JavaScript, this can come in the form of a library dependency like FlexSearch. Far too bulky for the humble sorting task I have at hand.

Javascript seems to have a comprehensive in memory solution https://github.com/nextapps-de/flexsearch

Another option that was often suggested to me was building the search index with a library such as https://github.com/nextapps-de/flexsearch and distribute the index than to the client and handle it one the client. But yeah sounds like a lot of overhead and I haven't tried it.