Versions in this module Expand all Collapse all v0 v0.1.0 Apr 27, 2026 Changes in this version + func PrepareTransform(content string, sharedContent map[string]string) string + func SplitFrontmatter(content string) (yamlBlock, body string, ok bool) + func Transform(content, version string) string + func VersionWildcard(version string) string + type Catalog struct + func NewCatalog(opts ...Option) *Catalog + func (c *Catalog) Index(ctx context.Context, version string) (*Index, error) + func (c *Catalog) Latest() string + func (c *Catalog) Read(ctx context.Context, version, slug string) ([]byte, error) + func (c *Catalog) ReadFile(ctx context.Context, version, relPath string) ([]byte, error) + func (c *Catalog) Versions() []string + type FS interface + type Index struct + Sections []Section + Version string + func (idx *Index) ByCategory(category string) []*Section + func (idx *Index) Children(slug string) []*Section + func (idx *Index) Lookup(slug string) (*Section, bool) + func (idx *Index) Search(term string, readContent func(slug string) string) []*Section + func (idx *Index) TopLevel() []*Section + func (idx *Index) Tree(rootSlug string, depth int) iter.Seq2[int, *Tree] + type Option func(*Catalog) + func WithBundleURL(url string) Option + func WithCacheDir(dir string) Option + func WithFS(fsys fs.FS) Option + func WithHTTPClient(client *http.Client) Option + func WithLocalOnly() Option + func WithRefreshTimeout(d time.Duration) Option + type Section struct + Aliases []string + Category string + Children []string + Description string + IsIndex bool + RelPath string + Slug string + Title string + Weight int + type Tree struct + Children []*Tree + type WriteDirFS interface + MkdirAll func(path string, perm fs.FileMode) error + RemoveAll func(path string) error + type WriteFileFS interface + WriteFile func(name string, data []byte, perm fs.FileMode) error
Go to main page