magidoc VS elasticlunr.js

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!

When i did my static site search function some time ago, I used Elasticlunr. I was able to pregenerate the index file as a big json file that is loaded at the client.

http://elasticlunr.com/

If your content is mostly static, you might want to consider pre-building an index and shipping it as a whole. You could look into something like

* https://stork-search.net/ (Rust/WASM)

* tinysearch: https://github.com/tinysearch/tinysearch (Rust/WASM)

* https://lunrjs.com/ (JS, simple, stable)

* http://elasticlunr.com/ - based on the former, slightly more sophisticated tuning options

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 ?

Check out elasticlunr

There's also Elasticlunr which is based off of lunr.js and is what mdBook uses

http://elasticlunr.com/

Does this relate to http://elasticlunr.com/? mdBook uses the latter, and I was wondering how I can parse/read its indexes from Python so I can provide my own search from them.

Same as above, for most blogs something like http://elasticlunr.com/ can get the job done really well.

3. HotSwap on the fly themes

Doctave comes with offline search built in. We use the elasticlunr-rs crate to generate a search index that is compatible with the elasticlunr.js library. You can see it in action by going to our docs (built with the CLI, naturally) and hitting the letter s on your keyboard to focus on the search bar. The searching happens entirely client-side.