hackmdio / hackmdio/codimd

Full text search

Open
#482 6 comments 13 reactions 0 assignees View on GitHub
feature Hacktoberfest
Dominant language
JavaScript
Stars
10.1k
Forks
1.1k
PR merge metrics
No merged PRs in 30d

Description

> *please mark as* [`feature`](https://github.com/hackmdio/hackmd/labels/feature) request

As a logged in user, I am presented with recently opened pads when visiting the splash page. These are custom to the user client and stored in local storage, as far as I know. There is no known synchronisation with the HackMD server.

This issue tries to anticipate what would be needed to implement full text search over pads.

Given the introductory assumptions, a search service would allow for POSTing a list of pads to crawl, index and query by the frontend client, which is the only source of lists of pads available.

Contributor guide

Open the contributing guide

Research direction

Start by tracing how the splash page obtains recently opened pads and how that list is stored in local storage. Then determine the frontend client’s requirements for submitting pads to a search service and receiving indexed queries. Done means the scope and interface for searching the available pad list are defined.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
frontend, search
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.