Prefer Headings Plugin

Note Read the git history if you want to understand more about this codebase. I can recommend the following commit(s): b527

I was previously using the front-matter-title plugin in order to display first headings instead of the filenames. It worked quite well until I tried to integrate the node package front-matter-title-api-provider with omnisearch.

I had quite a few problems trying to integrate the two. Mostly because of the non-standard frameworks used and the sheer commmplexity in front-matter-title making it difficult for me to understand how it even parsed #headings.

I did have a much easier time with the omnisearch codebase and managed to track down where the titles were rendered.

// obsidian-omnisearch/src/components/ResultItemVault.svelte (lines 19-22 & 41-46)

  export let note: ResultNote
  let title = ''

  $: {
    title = note.basename
    notePath = pathWithoutFilename(note.path)
    if (settings.ignoreDiacritics) {
      title = removeDiacritics(title)
    }
  }

I also realized that the if the object ResultNote had the parameter headings1 it would get automatically filled by IndexedDocument after some playing around with the code. Unfortunately while it did technically work, there were quite a few problems.

# obsidian-omnisearch/src/globals.ts

export type ResultNote = {
  score: number
  path: string
  basename: string
+ headings1: string  
  content: string
  foundWords: string[]
  matches: SearchMatch[]
}

I've grown sick of reading other people's codebases. So I've decided to try and make a much simpler and readable plugin with an api I can use to integrate with other plugins.

---

Now that I've confirmed that it's possible to use the obsidian api to print the first suggested result from [[title#heading]]. I suppose I could just query the api directly from omnisearch and use it's caching system as well. But, then I'd still have to keep front-matter-title to render headings over filenames everywhere else.

So, I think I'll continue work here. I plan on indexing and caching the first heading of all *.md files while respecting obsidian's excluded files. As well as, creating listeners to (re)cache new or updated files.

Afterwards, I'll have to somehow display the results as needed. And create an api which would take in path (folder/example.md) and resolve heading ('example heading`).