docute icon indicating copy to clipboard operation
docute copied to clipboard

Build a local search plugin

Open egoist opened this issue 8 years ago • 8 comments

Issuehunt badges

Using the plugin API for searching: https://docute.org/plugin-api#apienablesearchoptions


IssueHunt Summary

Backers (Total: $200.00)

Submitted pull Requests


Become a backer now!

Or submit a pull request to get the deposits!

Tips


IssueHunt has been backed by the following sponsors. Become a sponsor

egoist avatar Dec 17 '16 08:12 egoist

Any progress regarding this functionality? I want to migrate to docute, but I don't want to use Algolia 😩

Itherael avatar Jan 30 '18 20:01 Itherael

This vue component might be a good example (or potential component to integrate) to offer this: https://github.com/shayneo/vue-fuse/

phillbaker avatar Apr 03 '18 01:04 phillbaker

Now we have a plugin API for searching: https://docute.org/plugin-api#apienablesearchoptions

We just need to figure out how to create/store search-index.json

egoist avatar Jun 08 '19 09:06 egoist

@issuehunt has funded $200.00 to this issue.


IssueHuntBot avatar Jun 09 '19 03:06 IssueHuntBot

Given that this runs in browser might as well run it in memory. The files would have to be loaded from sidebar, parsed-https://github.com/markdown-it/markdown-it-, and then fed into a search library such as https://www.npmjs.com/package/lunr which takes objects and appears to return the whole tree made of object keys for a result. Ideally the link would be able to take you to that exact spot in text, or at least a paragraph, something a parser might not support like paragraph 1 after h3. When markdown component loads, do those link work via router or is it something browser supports with markdown?

janat08 avatar Jun 11 '19 08:06 janat08

So is it okay if search material is compiled at runtime, instead of having search-index.json produced before then?

janat08 avatar Jun 21 '19 19:06 janat08

Working on this. Can you please assign me?

benkoska avatar Sep 08 '19 23:09 benkoska

I created a pull request #261 that should close this.

benkoska avatar Sep 09 '19 12:09 benkoska