whimSYZ / lightSearch

A lightweight full-text search engine built for Markdown using Go.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

lightSearch

https://pkg.go.dev/github.com/whimSYZ/lightSearch Go Report Card

Full-text search in Go

Introduction

lightSearch is a lightweight full-text search engine built for Markdown developed in Go. It has optimizations specifically for Markdown documentation such as interpreting Front matter.

Install

go get github.com/whimSYZ/lightSearch

Usage

To use lightSearch:

package main

import (
    "fmt"
    "github.com/whimSYZ/lightSearch"
)

func main() {
    idx := load("./")

    res := idx.search("gallery")

    fmt.Println(res)
}

Dependencies

lightSearch uses gopkg.in/yaml.v2 for YAML Unmarshaler

Todos

  • Add weight calculations for front matter(title, description, etc.)
  • Add fuzzy query with levenshteinDistance

About

A lightweight full-text search engine built for Markdown using Go.

License:MIT License


Languages

Language:Go 100.0%