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 ¶
- func New() engine.Plugin
- type Plugin
- func (p *Plugin) Capabilities() []engine.Capability
- func (p *Plugin) ConfigSchema() []byte
- func (p *Plugin) Dependencies() []string
- func (p *Plugin) Emissions() []string
- func (p *Plugin) ID() string
- func (p *Plugin) Init(ctx engine.PluginContext) error
- func (p *Plugin) Name() string
- func (p *Plugin) Ready() error
- func (p *Plugin) Requires() []engine.Requirement
- func (p *Plugin) Shutdown(_ context.Context) error
- func (p *Plugin) Subscriptions() []engine.EventSubscription
- func (p *Plugin) Version() string
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
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 ¶
ConfigSchema implements engine.ConfigSchemaProvider.
func (*Plugin) Dependencies ¶
func (*Plugin) Ready ¶
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) Subscriptions ¶
func (p *Plugin) Subscriptions() []engine.EventSubscription