Versions in this module Expand all Collapse all v0 v0.63.3 Jan 28, 2020 Changes in this version + const KindHome + const KindPage + const KindSection + const KindTaxonomy + const KindTaxonomyTerm + var DefaultPageSort = func(p1, p2 Page) bool + var NilPage *nopPage + var NopPage Page = new(nopPage) + func Clear() error + func GetKind(s string) string + func MarshalPageToJSON(p Page) ([]byte, error) + func NewZeroFile(log *helpers.DistinctLogger) source.File + func ResolvePagerSize(cfg config.Provider, options ...interface{}) (int, error) + func SortByDefault(pages Pages) + func SortByLanguage(pages Pages) + type AlternativeOutputFormatsProvider interface + AlternativeOutputFormats func() OutputFormats + type Author struct + DisplayName string + Email string + FamilyName string + GivenName string + Image string + LongBio string + ShortBio string + Social AuthorSocial + Thumbnail string + type AuthorList map[string]Author + type AuthorProvider interface + Author func() Author + Authors func() AuthorList + type AuthorSocial map[string]string + type ChildCareProvider interface + Pages func() Pages + RegularPages func() Pages + Resources func() resource.Resources + type ContentProvider interface + Content func() (interface{}, error) + FuzzyWordCount func() int + Len func() int + Plain func() string + PlainWords func() []string + ReadingTime func() int + Summary func() template.HTML + Truncated func() bool + WordCount func() int + type Data map[string]interface + func (d Data) Pages() Pages + type DeprecatedErrorPageMethods interface + type DeprecatedWarningPageMethods interface + func NewDeprecatedWarningPage(p DeprecatedWarningPageMethods) DeprecatedWarningPageMethods + type DeprecatedWarningPageMethods1 interface + GetParam func(key string) interface{} + Hugo func() hugo.Info + IsDraft func() bool + LanguagePrefix func() string + RSSLink func() template.URL + URL func() string + type FileProvider interface + File func() source.File + type GetPageProvider interface + GetPage func(ref string) (Page, error) + type GitInfoProvider interface + GitInfo func() *gitmap.GitInfo + type InSectionPositioner interface + NextInSection func() Page + PrevInSection func() Page + type InternalDependencies interface + GetRelatedDocsHandler func() *RelatedDocsHandler + type OutputFormat struct + Format output.Format + Rel string + func NewOutputFormat(relPermalink, permalink string, isCanonical bool, f output.Format) OutputFormat + func (o OutputFormat) MediaType() media.Type + func (o OutputFormat) Name() string + func (o OutputFormat) Permalink() string + func (o OutputFormat) RelPermalink() string + type OutputFormats []OutputFormat + func (o OutputFormats) Get(name string) *OutputFormat + type OutputFormatsProvider interface + OutputFormats func() OutputFormats + type Page interface + type PageGenealogist interface + Related func(doc related.Document) (Pages, error) + RelatedIndices func(doc related.Document, indices ...interface{}) (Pages, error) + RelatedTo func(args ...types.KeyValues) (Pages, error) + type PageGroup struct + Key interface{} + func (p PageGroup) ProbablyEq(other interface{}) bool + func (p PageGroup) Slice(in interface{}) (interface{}, error) + type PageMetaProvider interface + Aliases func() []string + BundleType func() string + Description func() string + Draft func() bool + IsHome func() bool + IsNode func() bool + IsPage func() bool + IsSection func() bool + Keywords func() []string + Kind func() string + Lang func() string + Layout func() string + LinkTitle func() string + Param func(key interface{}) (interface{}, error) + Path func() string + Section func() string + SectionsEntries func() []string + SectionsPath func() string + Sitemap func() config.Sitemap + Slug func() string + Type func() string + Weight func() int + type PageRenderProvider interface + Render func(layout ...string) (template.HTML, error) + RenderString func(args ...interface{}) (template.HTML, error) + type PageWithoutContent interface + type Pager struct + func (p *Pager) First() *Pager + func (p *Pager) HasNext() bool + func (p *Pager) HasPrev() bool + func (p *Pager) Last() *Pager + func (p *Pager) Next() *Pager + func (p *Pager) NumberOfElements() int + func (p *Pager) PageGroups() PagesGroup + func (p *Pager) PageNumber() int + func (p *Pager) Pages() Pages + func (p *Pager) Prev() *Pager + func (p *Pager) URL() template.HTML + func (p Pager) String() string + type Pages []Page + func ToPages(seq interface{}) (Pages, error) + func (p Pages) ByDate() Pages + func (p Pages) ByExpiryDate() Pages + func (p Pages) ByLanguage() Pages + func (p Pages) ByLastmod() Pages + func (p Pages) ByLength() Pages + func (p Pages) ByLinkTitle() Pages + func (p Pages) ByParam(paramsKey interface{}) Pages + func (p Pages) ByPublishDate() Pages + func (p Pages) ByTitle() Pages + func (p Pages) ByWeight() Pages + func (p Pages) Group(key interface{}, in interface{}) (interface{}, error) + func (p Pages) GroupBy(key string, order ...string) (PagesGroup, error) + func (p Pages) GroupByDate(format string, order ...string) (PagesGroup, error) + func (p Pages) GroupByExpiryDate(format string, order ...string) (PagesGroup, error) + func (p Pages) GroupByParam(key string, order ...string) (PagesGroup, error) + func (p Pages) GroupByParamDate(key string, format string, order ...string) (PagesGroup, error) + func (p Pages) GroupByPublishDate(format string, order ...string) (PagesGroup, error) + func (p Pages) Len() int + func (p Pages) Limit(n int) Pages + func (p Pages) Next(cur Page) Page + func (p Pages) Prev(cur Page) Page + func (p Pages) Related(doc related.Document) (Pages, error) + func (p Pages) RelatedIndices(doc related.Document, indices ...interface{}) (Pages, error) + func (p Pages) RelatedTo(args ...types.KeyValues) (Pages, error) + func (p Pages) Reverse() Pages + func (p1 Pages) MergeByLanguage(p2 Pages) Pages + func (p1 Pages) MergeByLanguageInterface(in interface{}) (interface{}, error) + func (pages Pages) ProbablyEq(other interface{}) bool + func (pages Pages) ToResources() resource.Resources + func (ps Pages) String() string + type PagesFactory func() Pages + type PagesGroup []PageGroup + func ToPagesGroup(seq interface{}) (PagesGroup, error) + func (p PagesGroup) Reverse() PagesGroup + func (psg PagesGroup) Len() int + func (psg PagesGroup) ProbablyEq(other interface{}) bool + type Paginator struct + func Paginate(td TargetPathDescriptor, seq interface{}, pagerSize int) (*Paginator, error) + func (p *Paginator) PageSize() int + func (p *Paginator) Pagers() pagers + func (p *Paginator) TotalNumberOfElements() int + func (p *Paginator) TotalPages() int + type PaginatorProvider interface + Paginate func(seq interface{}, options ...interface{}) (*Pager, error) + Paginator func(options ...interface{}) (*Pager, error) + type PermalinkExpander struct + func NewPermalinkExpander(ps *helpers.PathSpec) (PermalinkExpander, error) + func (l PermalinkExpander) Expand(key string, p Page) (string, error) + type Positioner interface + Next func() Page + NextPage func() Page + Prev func() Page + PrevPage func() Page + type RawContentProvider interface + RawContent func() string + type RefProvider interface + Ref func(argsm map[string]interface{}) (string, error) + RefFrom func(argsm map[string]interface{}, source interface{}) (string, error) + RelRef func(argsm map[string]interface{}) (string, error) + RelRefFrom func(argsm map[string]interface{}, source interface{}) (string, error) + type RelatedDocsHandler struct + func NewRelatedDocsHandler(cfg related.Config) *RelatedDocsHandler + func (s *RelatedDocsHandler) Clone() *RelatedDocsHandler + type RelatedKeywordsProvider interface + RelatedKeywords func(cfg related.IndexConfig) ([]related.Keyword, error) + type ShortcodeInfoProvider interface + HasShortcode func(name string) bool + type Site interface + BaseURL func() template.URL + Data func() map[string]interface{} + Hugo func() hugo.Info + IsServer func() bool + Language func() *langs.Language + LastChange func() time.Time + Menus func() navigation.Menus + Pages func() Pages + Params func() maps.Params + RegularPages func() Pages + ServerPort func() int + Sites func() Sites + Taxonomies func() interface{} + Title func() string + func NewDummyHugoSite(cfg config.Provider) Site + type Sites []Site + func (s Sites) First() Site + type SitesProvider interface + Site func() Site + Sites func() Sites + type TableOfContentsProvider interface + TableOfContents func() template.HTML + type TargetPathDescriptor struct + Addends string + BaseName string + Dir string + ExpandedPermalink string + ForcePrefix bool + Kind string + PathSpec *helpers.PathSpec + PrefixFilePath string + PrefixLink string + Sections []string + Type output.Format + URL string + UglyURLs bool + type TargetPaths struct + Link string + SubResourceBaseLink string + SubResourceBaseTarget string + TargetFilename string + func CreateTargetPaths(d TargetPathDescriptor) (tp TargetPaths) + func (p TargetPaths) PermalinkForOutputFormat(s *helpers.PathSpec, f output.Format) string + func (p TargetPaths) RelPermalink(s *helpers.PathSpec) string + type TranslationsProvider interface + AllTranslations func() Pages + IsTranslated func() bool + Translations func() Pages + type TreeProvider interface + CurrentSection func() Page + FirstSection func() Page + InSection func(other interface{}) (bool, error) + IsAncestor func(other interface{}) (bool, error) + IsDescendant func(other interface{}) (bool, error) + Page func() Page + Parent func() Page + Sections func() Pages + type WeightedPage struct + Weight int + func NewWeightedPage(weight int, p Page, owner Page) WeightedPage + func (p WeightedPage) Slice(in interface{}) (interface{}, error) + func (w WeightedPage) String() string + type WeightedPages []WeightedPage + func (p WeightedPages) Page() Page + func (wp WeightedPages) Count() int + func (wp WeightedPages) Len() int + func (wp WeightedPages) Less(i, j int) bool + func (wp WeightedPages) Next(cur Page) Page + func (wp WeightedPages) Pages() Pages + func (wp WeightedPages) Prev(cur Page) Page + func (wp WeightedPages) Sort() + func (wp WeightedPages) Swap(i, j int)