nix

package
v0.4.10 Latest Latest
Warning

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

Go to latest
Published: Aug 5, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func MakeKey

func MakeKey(source config.Source, id string) string

Types

type Docs added in v0.2.0

type Docs struct {
	Plain    string           `json:",omitempty"`
	Markdown nixdocs.Markdown `json:",omitempty"`
}

type License

type License struct {
	FullName    string
	Name        string
	SPDXId      string
	URL         string
	AppendixURL string
}
type Link struct {
	Name string
	URL  string
}

type Maintainer

type Maintainer struct {
	Github string
	Name   string
}

type Option

type Option struct {
	Name            string
	Source          string
	Declarations    []Link
	Default         *Docs `json:",omitempty"`
	Description     nixdocs.Markdown
	Example         *Docs `json:",omitempty"`
	Loc             []string
	OptionSet       string
	Parents         []string
	RelatedPackages nixdocs.Markdown `json:",omitempty"`
	Type            string
	ImportedAt      time.Time
}

func (Option) BleveType

func (Option) BleveType() string

func (Option) GetName

func (p Option) GetName() string

func (Option) GetSource

func (p Option) GetSource() string

func (Option) ImporterType added in v0.3.0

func (Option) ImporterType() string

type Package

type Package struct {
	Name            string
	Attribute       string
	Source          string
	Broken          bool
	Definition      string
	Description     string
	Homepages       []string
	Licenses        []License
	LongDescription nixdocs.Markdown
	MainProgram     string
	Programs        []string
	Maintainers     []Maintainer
	PackageSet      string
	Platforms       []string
	Version         string
	ImportedAt      time.Time
}

func (Package) BleveType

func (Package) BleveType() string

func (Package) GetName

func (p Package) GetName() string

func (Package) GetSource

func (p Package) GetSource() string

func (Package) ImporterType added in v0.3.0

func (Package) ImporterType() string

Jump to

Keyboard shortcuts

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