docsite

Aug 17, 2023

Changes in this version

type Site

+ func (s *Site) GetResources(dir, version string) (http.FileSystem, error)

Feb 8, 2022

Changes in this version

type Site

+ SkipIndexURLPattern *regexp.Regexp

Sep 27, 2021

Changes in this version

type Site

+ Root *url.URL

Nov 9, 2019

Changes in this version

type Site

+ func (s *Site) Search(ctx context.Context, contentVersion string, queryStr string) (*search.Result, error)

Nov 9, 2019

Changes in this version

+ func IsContentAsset(urlPath string) bool

+ func ReadFile(fs http.FileSystem, path string) ([]byte, error)

+ func WalkFileSystem(fs http.FileSystem, filterFn func(path string) bool, ...) error

+ type ContentPage struct

+ Breadcrumbs []breadcrumbEntry

+ Data []byte

+ Doc markdown.Document

+ FilePath string

+ Path string

+ type PageData struct

+ Content *ContentPage

+ ContentPageNotFoundError bool

+ ContentPagePath string

+ ContentVersion string

+ ContentVersionNotFoundError bool

+ type Site struct

+ Assets http.FileSystem

+ AssetsBase *url.URL

+ Base *url.URL

+ CheckIgnoreURLPattern *regexp.Regexp

+ Content VersionedFileSystem

+ ContentExcludePattern *regexp.Regexp

+ Redirects map[string]*url.URL

+ Templates http.FileSystem

+ func (s *Site) AllContentPages(ctx context.Context, contentVersion string) ([]*ContentPage, error)

+ func (s *Site) Check(ctx context.Context, contentVersion string) (problems []string, err error)

+ func (s *Site) Handler() http.Handler

+ func (s *Site) RenderContentPage(page *PageData) ([]byte, error)

+ func (s *Site) ResolveContentPage(ctx context.Context, contentVersion, path string) (*ContentPage, error)

+ type VersionedFileSystem interface

+ OpenVersion func(ctx context.Context, version string) (http.FileSystem, error)