markdownindex

package
v0.31.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 31, 2026 License: MIT Imports: 12 Imported by: 0

Documentation

Overview

Package markdownindex implements a lexical-only markdown indexer. It walks a directory of markdown (.md) files, parses YAML frontmatter, splits each file on `##` headings, and upserts one record per section into the search.lexical capability (BM25 / SQLite FTS5). No embeddings, no vector store — the index is pure keyword search over the filesystem.

Frontmatter title and tags are folded into each section's indexed text so brand and topic terms remain discoverable from any section. Indexing runs once at Ready; re-running re-upserts deterministic IDs in place.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func New

func New() engine.Plugin

Types

type Plugin

type Plugin struct {
	// contains filtered or unexported fields
}

Plugin walks docsDir at Ready and writes section records to the lexical store.

func (*Plugin) Capabilities

func (p *Plugin) Capabilities() []engine.Capability

func (*Plugin) ConfigSchema

func (p *Plugin) ConfigSchema() []byte

ConfigSchema implements engine.ConfigSchemaProvider.

func (*Plugin) Dependencies

func (p *Plugin) Dependencies() []string

func (*Plugin) Emissions

func (p *Plugin) Emissions() []string

func (*Plugin) ID

func (p *Plugin) ID() string

func (*Plugin) Init

func (p *Plugin) Init(ctx engine.PluginContext) error

func (*Plugin) Name

func (p *Plugin) Name() string

func (*Plugin) Ready

func (p *Plugin) Ready() error

Ready walks docsDir and indexes every matching file. It runs after all plugins Init, so the search.lexical provider is subscribed and ready.

func (*Plugin) Requires

func (p *Plugin) Requires() []engine.Requirement

func (*Plugin) Shutdown

func (p *Plugin) Shutdown(_ context.Context) error

func (*Plugin) Subscriptions

func (p *Plugin) Subscriptions() []engine.EventSubscription

func (*Plugin) Version

func (p *Plugin) Version() string

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL