server

May 27, 2026

Changes in this version

+ type WellKnownHandler struct

+ func NewWellKnownHandler(deps HandlerDeps) *WellKnownHandler

+ func (h *WellKnownHandler) CanHandle(path string) bool

+ func (h *WellKnownHandler) ServeHTTP(w http.ResponseWriter, r *http.Request)

May 26, 2026

Changes in this version

type PackageSummary

+ LatestVersion string

+ type ServeOption func(*serveHandlerConfig)

+ func WithSSRURL(url string) ServeOption

type ServeSettings

+ SSRURL string

May 12, 2026

Changes in this version

+ func SlugifyHeading(text string) string

+ type SectionHeading struct

+ ID string

+ Level int

+ Text string

+ func ExtractHeadings(content, sectionTitle string) []SectionHeading

type SectionSummary

+ Headings []SectionHeading

type ServeSettings

+ ReloadInterval string

May 2, 2026

Changes in this version

+ type ListPackagesResponse struct

+ DefaultPackage string

+ DefaultVersion string

+ Packages []PackageSummary

type ListSectionsParams

+ PackageName string

+ PackageVersion string

+ type PackageSummary struct

+ DisplayName string

+ Name string

+ SectionCount int

+ Versions []string

type SectionDetail

+ PackageName string

+ PackageVersion string

type SectionSummary

+ PackageName string

+ PackageVersion string

type ServeSettings

+ FromSQLiteDir []string

Apr 28, 2026

Changes in this version

type ServeSettings

+ FromGlazedCmd []string

+ FromJSON []string

+ FromSQLite []string

+ WithEmbedded bool

Apr 9, 2026

Changes in this version

+ const APIPathPrefix

+ const DefaultAddr

+ func MountPrefix(prefix string, h http.Handler) http.Handler

+ func NewCORSHandler(h http.Handler) http.Handler

+ func NewHandler(deps HandlerDeps) http.Handler

+ func NewMountedHandler(prefix string, deps HandlerDeps, spaHandler http.Handler) http.Handler

+ func NewServeHandler(deps HandlerDeps, spaHandler http.Handler) http.Handler

+ type ErrorResponse struct

+ Error string

+ Message string

+ type Handler struct

+ func (h *Handler) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ type HandlerDeps struct

+ Logger *slog.Logger

+ Store *store.Store

+ type HealthResponse struct

+ OK bool

+ Sections int

+ type ListSectionsParams struct

+ Command string

+ Flag string

+ Limit int

+ Offset int

+ Search string

+ SectionType string

+ Topic string

+ type ListSectionsResponse struct

+ Limit int

+ Offset int

+ Sections []SectionSummary

+ Total int

+ type SectionDetail struct

+ Commands []string

+ Content string

+ Flags []string

+ ID int64

+ IsTopLevel bool

+ Short string

+ Slug string

+ Title string

+ Topics []string

+ Type string

+ func DetailFromModel(s *model.Section) SectionDetail

+ type SectionSummary struct

+ ID int64

+ IsTopLevel bool

+ Short string

+ Slug string

+ Title string

+ Topics []string

+ Type string

+ func SummaryFromModel(s *model.Section) SectionSummary

+ type ServeCommand struct

+ func NewServeCommand(hs *help.HelpSystem, spaHandler http.Handler) (*ServeCommand, error)

+ func (sc *ServeCommand) Run(ctx context.Context, parsedValues *values.Values) error

+ type ServeSettings struct

+ Address string

+ Paths []string