search

Documentation

Overview

Package search implements site search.

Index

• type DocumentResult
• type Result
  • func Search(query query.Query, index *index.Index) (*Result, error)
• type SectionResult

Types

type DocumentResult

type DocumentResult struct {
	index.DocumentResult
	SectionResults []SectionResult
}

DocumentResult is the result of a search for a single document

type Result

type Result struct {
	DocumentResults []DocumentResult // document results
	Total           int              // total number of document results
}

Result is the result of a search.

func Search

func Search(query query.Query, index *index.Index) (*Result, error)

type SectionResult

type SectionResult struct {
	ID         string   // the URL fragment (without "#") of the section, or empty if in the first section
	IDStack    []string // the stack of section IDs
	Title      string   // the section title
	TitleStack []string // the stack of section titles
	Excerpts   []string // the match excerpt
}