provider

package
v1.3.7 Latest Latest
Warning

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

Go to latest
Published: Mar 25, 2026 License: MIT Imports: 5 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Documentation

type Documentation struct {
	Name        string            `json:"name"`
	DisplayName string            `json:"displayName"`
	Description string            `json:"description"`
	Topics      map[string]*Topic `json:"topics"`
}

type Provider

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

func NewProvider

func NewProvider(cacheDir string) (*Provider, error)

func (*Provider) GetDoc

func (p *Provider) GetDoc(id, doc, topic string) (string, error)

func (*Provider) ListDocumentations

func (p *Provider) ListDocumentations() []Documentation

func (*Provider) Search

func (p *Provider) Search(query string, documentation string) []SearchResult

type SearchResult

type SearchResult struct {
	ID            string  `json:"id"`
	Title         string  `json:"title"`
	Description   string  `json:"description"`
	Documentation string  `json:"documentation"`
	Score         float64 `json:"score"`
}

type Topic

type Topic struct {
	ID            string   `json:"id"`
	Title         string   `json:"title"`
	Description   string   `json:"description"`
	Content       string   `json:"content"`
	Keywords      []string `json:"keywords"`
	Documentation string   `json:"documentation"`
}

Jump to

Keyboard shortcuts

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