valueobject

Jan 11, 2025

Changes in this version

type Pager

+ func (p *Pager) First() contenthub.Pager

+ func (p *Pager) Last() contenthub.Pager

Jan 7, 2025

Changes in this version

type ContentSummary

+ MarkdownResult markdown.Result

Jan 1, 2025

Changes in this version

+ func GetPluralCount(v any) any

+ func SetupDefaultContentTypes()

type ContentSummary

+ func (c *ContentSummary) ExtractSummary(input []byte, mt media.Type)

+ func (c *ContentSummary) IsSummaryEmpty() bool

+ type ContentTypes struct

+ AsciiDoc media.Type

+ EmacsOrgMode media.Type

+ HTML media.Type

+ Markdown media.Type

+ Pandoc media.Type

+ ReStructuredText media.Type

+ var DefaultContentTypes ContentTypes

+ func (t ContentTypes) FromTypes(types media.Types) ContentTypes

+ func (t ContentTypes) IsContentFile(filename string) bool

+ func (t ContentTypes) IsContentSuffix(suffix string) bool

+ func (t ContentTypes) IsHTMLSuffix(suffix string) bool

+ func (t ContentTypes) IsIndexContentFile(filename string) bool

+ func (t ContentTypes) Types() media.Types

type File

+ func (fi *File) Type() string

type FrontMatter

+ Date time.Time

+ func NewFrontMatter() *FrontMatter

+ type HtmlSummary struct

+ Divider types.LowHigh[string]

+ SummaryEndTag types.LowHigh[string]

+ SummaryLowHigh types.LowHigh[string]

+ WrapperEnd types.LowHigh[string]

+ WrapperStart types.LowHigh[string]

+ func (s *HtmlSummary) Content() string

+ func (s *HtmlSummary) ContentWithoutSummary() string

+ func (s *HtmlSummary) Summary() string

+ func (s *HtmlSummary) Truncated() bool

+ func (s *HtmlSummary) Value(l types.LowHigh[string]) string

+ type IntCount int

+ func (c IntCount) Count() int

+ type PageGroup struct

+ func (p *PageGroup) Append(page contenthub.Page) contenthub.Pages

+ func (p *PageGroup) Key() string

+ func (p *PageGroup) Pages() contenthub.Pages

+ type Pager struct

+ func (p *Pager) HasNext() bool

+ func (p *Pager) HasPrev() bool

+ func (p *Pager) Next() contenthub.Pager

+ func (p *Pager) NumberOfElements() int

+ func (p *Pager) PageNumber() int

+ func (p *Pager) Pages() contenthub.Pages

+ func (p *Pager) Prev() contenthub.Pager

+ func (p *Pager) URL() string

+ type Paginator struct

+ func NewPaginatorFromPageGroups(pageGroups contenthub.PageGroups, size int, base string) (*Paginator, error)

+ func NewPaginatorFromPages(pages contenthub.Pages, size int, base string) (*Paginator, error)

+ func (p *Paginator) Pagers() pagers

+ func (p *Paginator) TotalPages() int

+ type PaginatorEmpty func() error

+ func (f PaginatorEmpty) Current() contenthub.Pager

+ func (f PaginatorEmpty) Paginate(groups contenthub.PageGroups) (contenthub.Pager, error)

+ func (f PaginatorEmpty) Paginator() (contenthub.Pager, error)

+ func (f PaginatorEmpty) SetCurrent(current contenthub.Pager)

type Target

+ func (t *Target) TargetFileBase() string

Nov 17, 2024

Changes in this version

type FrontMatter

+ Params maps.Params

Nov 6, 2024

Changes in this version

+ func SortByWeight(pages contenthub.Pages)

type FrontMatter

+ Weight int

Oct 21, 2024

Changes in this version

+ const KindHome

+ const KindPage

+ const KindRSS

+ const KindRobotsTXT

+ const KindSection

+ const KindSitemap

+ const KindSitemapIndex

+ const KindStatus404

+ const KindTaxonomy

+ const KindTerm

+ const ShortcodePlaceholderPrefix

+ var AllKinds []string

+ var AllKindsInPages []string

+ var DefaultTocConfig = TocConfig

+ var MDProvider contenthub.ProviderProvider = provide

+ var NilPage *nopPage

+ var TocShortcodePlaceholder = CreateShortcodePlaceholder("TOC", 0, 0)

+ var ZeroShortcode = prerenderedShortcode

+ func AddFileInfoToError(err error, fi fs.FileMetaInfo, fs afero.Fs) error

+ func CheckCascadePattern(m PageMatcher)

+ func CreateShortcodePlaceholder(sid string, id uint64, ordinal int) string

+ func DecodeCascadeConfig(in any) (map[PageMatcher]maps.Params, error)

+ func GetKindAny(s string) string

+ func GetKindMain(s string) string

+ func GetParam(p maps.Params, key string, stringToLower bool) any

+ func GetParamToLower(m maps.Params, key string) any

+ func IsBranch(kind string) bool

+ func IsDeprecatedAndReplacedWith(s string) string

+ func MustUnwrapPage(in any) contenthub.Page

+ func NewPageInfo(name, kind, dir string, sections []string, buf *bytes.Buffer) contenthub.PageInfo

+ func NewZeroFile() contenthub.File

+ func PosFromInput(filename string, input []byte, offset int) text.Position

+ func PutPagePathBuilder(b *PagePathBuilder)

+ func SortByDefault(pages contenthub.Pages)

+ func SortByLanguage(pages contenthub.Pages)

+ func UniqueStringsReuse(s []string) []string

+ type BundleType int

+ const BundleTypeBranch

+ const BundleTypeContentResource

+ const BundleTypeContentSingle

+ const BundleTypeFile

+ const BundleTypeLeaf

+ func (b BundleType) IsBranchBundle() bool

+ func (b BundleType) IsBundle() bool

+ func (b BundleType) IsContent() bool

+ func (b BundleType) IsContentResource() bool

+ func (b BundleType) IsLeafBundle() bool

+ type Cascade struct

+ func NewCascade(cas any) (*Cascade, error)

+ type ContentSummary struct

+ Content template.HTML

+ Summary template.HTML

+ SummaryTruncated bool

+ TableOfContentsHTML template.HTML

+ func NewEmptyContentSummary() ContentSummary

+ type ConverterProvider struct

+ func (n ConverterProvider) Name() string

+ func (n ConverterProvider) New(ctx markdown.DocumentContext) (contenthub.Converter, error)

+ type ConverterRegistry struct

+ Converters map[string]contenthub.ConverterProvider

+ func (r *ConverterRegistry) Get(name string) contenthub.ConverterProvider

+ type File struct

+ func NewFileInfo(fi fs.FileMetaInfo) *File

+ func (fi *File) BaseFileName() string

+ func (fi *File) ContentBaseName() string

+ func (fi *File) Dir() string

+ func (fi *File) Ext() string

+ func (fi *File) FileInfo() fs.FileMetaInfo

+ func (fi *File) Filename() string

+ func (fi *File) IsZero() bool

+ func (fi *File) LogicalName() string

+ func (fi *File) Open() (io.ReadSeekCloser, error)

+ func (fi *File) Opener() io.OpenReadSeekCloser

+ func (fi *File) PageFile() contenthub.File

+ func (fi *File) Path() string

+ func (fi *File) Paths() *paths.Path

+ func (fi *File) RelPath() string

+ func (fi *File) Section() string

+ func (fi *File) ShiftToResource()

+ func (fi *File) String() string

+ func (fi *File) TranslationBaseName() string

+ func (fi *File) UniqueID() string

+ type FileManager struct

+ func NewFsManager(fis []fs.FileMetaInfo) *FileManager

+ func (f *FileManager) GetLeaf() *File

+ type FrontMatter struct

+ Kind string

+ Lang string

+ Path string

+ Terms map[string][]string

+ Title string

+ type FrontMatterParser struct

+ LangSvc contenthub.LangService

+ Params maps.Params

+ TaxonomySvc contenthub.TaxonomyService

+ func (b *FrontMatterParser) Parse() (*FrontMatter, error)

+ type Identity struct

+ Id uint64

+ Lang string

+ LangIdx int

+ func (i Identity) ID() int

+ func (i Identity) IdentifierBase() string

+ func (i Identity) PageIdentity() contenthub.PageIdentity

+ func (i Identity) PageLanguage() string

+ func (i Identity) PageLanguageIndex() int

+ type ItemHandler func(item pageparser.Item) error

+ type IterHandler func(item pageparser.Item, iter *pageparser.Iterator) error

+ type LayoutDescriptor struct

+ Baseof bool

+ Extension string

+ FormatName string

+ Kind string

+ KindVariants string

+ Lang string

+ Layout string

+ LayoutOverride bool

+ RenderingHook bool

+ Section string

+ Type string

+ type LayoutHandler struct

+ func NewLayoutHandler() *LayoutHandler

+ func (l *LayoutHandler) For(d LayoutDescriptor) ([]string, error)

+ type LayoutLooker struct

+ func NewLayoutLooker(names []string, bnames []string) *LayoutLooker

+ func (l *LayoutLooker) BaseNames() []string

+ func (l *LayoutLooker) Names() []string

+ type PageContentReplacement struct

+ Source pageparser.Item

+ Val []byte

+ type PageMatcher struct

+ Environment string

+ Kind string

+ Lang string

+ Path string

+ func (m PageMatcher) Matches(p contenthub.Page) bool

+ type PageMatcherParamsConfig struct

+ Params maps.Params

+ Target PageMatcher

+ type PagePathBuilder struct

+ BaseNameSameAsType bool

+ FullSuffix string

+ IsUgly bool

+ LinkUpperOffset int

+ NoSubResources bool

+ PrefixPath string

+ func GetPagePathBuilder(format output.Format) *PagePathBuilder

+ func (p *PagePathBuilder) Add(el ...string)

+ func (p *PagePathBuilder) ConcatLast(s string)

+ func (p *PagePathBuilder) IsHtmlIndex() bool

+ func (p *PagePathBuilder) Last() string

+ func (p *PagePathBuilder) Link() string

+ func (p *PagePathBuilder) LinkDir() string

+ func (p *PagePathBuilder) Path(upperOffset int) string

+ func (p *PagePathBuilder) PathDir() string

+ func (p *PagePathBuilder) PathDirBase() string

+ func (p *PagePathBuilder) PathFile() string

+ func (p *PagePathBuilder) Prepend(el ...string)

+ func (p *PagePathBuilder) Sanitize()

+ type PageWrapper interface

+ type Shortcode struct

+ DoMarkup bool

+ Indentation string

+ Info template.Info

+ Inner []any

+ IsClosing bool

+ IsInline bool

+ Length int

+ Name string

+ Ordinal int

+ Params any

+ Placeholder string

+ Pos int

+ Templs []template.Preparer

+ func (s Shortcode) InsertPlaceholder() bool

+ func (s Shortcode) NeedsInner() bool

+ type ShortcodeParser struct

+ func NewShortcodeParser(source []byte, pid uint64, tmplSvc contenthub.Template) *ShortcodeParser

+ func (s *ShortcodeParser) ParseItem(it pageparser.Item, pt *pageparser.Iterator) (*Shortcode, error)

+ type ShortcodeRenderFunc func(context.Context) ([]byte, bool, error)

+ func (f ShortcodeRenderFunc) RenderShortcode(ctx context.Context) ([]byte, bool, error)

+ func (f ShortcodeRenderFunc) RenderShortcodeString(ctx context.Context) (string, bool, error)

+ type ShortcodeRenderer interface

+ RenderShortcode func(context.Context) ([]byte, bool, error)

+ RenderShortcodeString func(context.Context) (string, bool, error)

+ func NewPrerenderedShortcode(s string, hasVariants bool) ShortcodeRenderer

+ type SourceHandlers interface

+ BytesHandler func() ItemHandler

+ FrontMatterHandler func() ItemHandler

+ ShortcodeHandler func() IterHandler

+ SummaryHandler func() IterHandler

+ type SourceParseInfo struct

+ Handlers SourceHandlers

+ ItemsStep1 pageparser.Items

+ Source []byte

+ func NewSourceParseInfo(source []byte, handlers SourceHandlers) (*SourceParseInfo, error)

+ func (s *SourceParseInfo) Handle() error

+ func (s *SourceParseInfo) IsEmpty() bool

+ func (s *SourceParseInfo) Parse() error

+ type Target struct

+ FilePath string

+ Format output.Format

+ Prefix string

+ SubResourceBaseTarget string

+ func (t *Target) TargetFilePath() string

+ func (t *Target) TargetFormat() output.Format

+ func (t *Target) TargetPrefix() string

+ func (t *Target) TargetSubResourceDir() string

+ type TocConfig struct

+ EndLevel int

+ Ordered bool

+ StartLevel int

+ type WhatChanged struct

+ IdentitySet identity.Identities

+ func (w *WhatChanged) Add(ids ...identity.Identity)

+ func (w *WhatChanged) Changes() []identity.Identity