obsidianmd / obsidianmd/obsidian-developer-docs

correct usage of SearchResult and SearchMatches needs clarification

Open
#140 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
521
Forks
174
PR merge metrics
No merged PRs in 30d

Description

I am trying to build a plugin that performs a search on the user's vault and returns search results. I want to use native obsidian components for this as much as possible, and I see that there are typescript componts that seem to be designed for this. However after spending many hours in the docs it is not clear to me how to use the Search related typescript API classes and interfaces properly.

The documentation should be improved to clarify the capabilities and usage of Search related components and functions. Without this, the only practical option is to recreate the functionality from scratch in Svelte or React or plain javascript.

Related docs pages:
https://docs.obsidian.md/Reference/TypeScript+API/SearchResult
https://docs.obsidian.md/Reference/TypeScript+API/SearchMatches
https://docs.obsidian.md/Reference/TypeScript+API/renderResults

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the SearchResult, SearchMatches, and renderResults documentation pages linked in the issue, and trace how their capabilities and usage should be explained for a vault-search plugin. Done means the pages clearly show how to use the native search components to return and render results without recreating the functionality.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.