egoist / docute

📚 Effortless documentation, done right.
https://docute.egoist.dev
MIT License
3.8k stars 427 forks source link

Build a local search plugin #261

Open benkoska opened 4 years ago

benkoska commented 4 years ago

Closes #21

Users have to add localSearch to their plugins to enable it. It loops through all items in the Navbar and makes them searchable.


IssueHunt Summary ### Referenced issues This pull request has been submitted to: - [#21: Build a local search plugin](https://issuehunt.io/repos/75962459/issues/21) --- IssueHunt has been backed by the following sponsors. [Become a sponsor](https://issuehunt.io/membership/members)
egoist commented 4 years ago

The local-search plugin should be built on top of this API (https://docute.org/plugin-api#apienablesearchoptions) and register a SearchBar component in NavBar 😄

And it should search from not only the sidebar but also the page contents.

benkoska commented 4 years ago

It uses the enable search options APi

Get Outlook for iOShttps://aka.ms/o0ukef


From: EGOIST notifications@github.com Sent: Sunday, September 15, 2019 12:21 To: egoist/docute Cc: Ben Koska; Author Subject: Re: [egoist/docute] Build a local search plugin (#261)

The local-search plugin should be built on top of this API (https://docute.org/plugin-api#apienablesearchoptionshttps://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fdocute.org%2Fplugin-api%23apienablesearchoptions&data=02%7C01%7C%7C153ac1792b504b964ff708d739c66997%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637041396641636166&sdata=nq3aJjJjMj%2FMY7l4%2Ba0Q0vLemM%2FZnEoi2T%2BPKf%2FWqkQ%3D&reserved=0) and register an SearchBar component in NavBar 😄

— You are receiving this because you authored the thread. Reply to this email directly, view it on GitHubhttps://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fegoist%2Fdocute%2Fpull%2F261%3Femail_source%3Dnotifications%26email_token%3DAEEENPNBTHSNWZEGK6IB3UDQJYEARA5CNFSM4IU2MRGKYY3PNVWWK3TUL52HS4DFVREXG43VMVBW63LNMVXHJKTDN5WW2ZLOORPWSZGOD6XNXHY%23issuecomment-531553183&data=02%7C01%7C%7C153ac1792b504b964ff708d739c66997%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637041396641646177&sdata=oOe9ZbAbCL5rOh89OzESQIvyfDEiagqwfG6LI79coaA%3D&reserved=0, or mute the threadhttps://eur01.safelinks.protection.outlook.com/?url=https%3A%2F%2Fgithub.com%2Fnotifications%2Funsubscribe-auth%2FAEEENPODRPGP7GHGOT43DH3QJYEARANCNFSM4IU2MRGA&data=02%7C01%7C%7C153ac1792b504b964ff708d739c66997%7C84df9e7fe9f640afb435aaaaaaaaaaaa%7C1%7C0%7C637041396641656182&sdata=ek2T7aF8KCa9ke3BjjSq1OlT0e433oKITQ86s4ZXRjU%3D&reserved=0.

mbryne commented 4 years ago

What was the outcome of this?

egoist commented 4 years ago

It would be better if it can retrieve all headers in pages and search them as well.

egoist commented 4 years ago

Are you still working on this? As I said, I can merge it if it also searches markdown headings.