entity

package

Go to main page

Versions in this module

v0

v0.1.5

Jan 7, 2025

v0.1.4

Jan 7, 2025

Changes in this version

type ContentProvider

+ func (c *ContentProvider) Result() markdown.Result

type PageBuilder

+ func (b *PageBuilder) WithLangIdx(idx int) *PageBuilder

v0.1.3

Jan 1, 2025

v0.1.2

Jan 1, 2025

v0.1.1

Jan 1, 2025

Changes in this version

+ const ArtificialLangTagPrefix

type Content

+ func (c *Content) IsEmpty() bool

+ func (c *Content) Truncated() bool

type Meta

+ Date time.Time

+ func (m *Meta) PageDate() time.Time

type Page

+ func (p *Page) Parent() contenthub.Page

+ func (p *Page) RegularPages() contenthub.Pages

type PageBuilder

+ ContentHub *ContentHub

+ type PageFinder struct

+ Fs contenthub.FsService

+ PageMapper *PageMap

+ func (pf *PageFinder) GetPageFromPath(path string) (contenthub.Page, error)

+ func (pf *PageFinder) GetPageRef(context contenthub.Page, ref string, home contenthub.Page) (contenthub.Page, error)

type PageMap

+ func (m *PageMap) SetupReverseIndex()

+ type PageShifter struct

+ func (s *PageShifter) Shift(n *PageTreesNode, dimension doctree.Dimension, exact bool) (*PageTreesNode, bool, doctree.DimensionFlag)

+ type Paginator struct

+ func NewPaginator(svc PaginatorSvc, page contenthub.Page) *Paginator

+ func (p *Paginator) Current() contenthub.Pager

+ func (p *Paginator) Paginate(groups contenthub.PageGroups) (contenthub.Pager, error)

+ func (p *Paginator) Paginator() (contenthub.Pager, error)

+ func (p *Paginator) SetCurrent(current contenthub.Pager)

+ type PaginatorSvc interface

+ GlobalRegularPages func() contenthub.Pages

+ PageSize func() int

+ type Shifter struct

+ func (s *Shifter) Delete(n *PageTreesNode, dimension doctree.Dimension) (bool, bool)

+ func (s *Shifter) ForEachInDimension(n *PageTreesNode, d int, f func(*PageTreesNode) bool)

+ func (s *Shifter) Insert(old, new *PageTreesNode) *PageTreesNode

+ func (s *Shifter) InsertInto(old, new *PageTreesNode, dimension doctree.Dimension) *PageTreesNode

+ func (s *Shifter) Shift(n *PageTreesNode, dimension doctree.Dimension, exact bool) (*PageTreesNode, bool, doctree.DimensionFlag)

type ShortcodeWithPage

+ func (scp *ShortcodeWithPage) UnwrapPage() contenthub.Page

type Source

+ func (p *Source) PosOffset(offset int) text.Position

+ type TranslateFunc func(ctx context.Context, translationID string, templateData any) string

+ type Translator struct

+ ContentLanguage string

+ Log loggers.Logger

+ TranslateFuncs map[string]TranslateFunc

+ func (t *Translator) SetupTranslateFuncs(bndl *i18n.Bundle)

+ func (t *Translator) Translate(ctx context.Context, lang string, translationID string, templateData any) string

v0.1.0

Dec 9, 2024

v0.0.14

Nov 26, 2024

Changes in this version

+ const TermTag

v0.0.13

Nov 24, 2024

Changes in this version

type Meta

+ func (m *Meta) NoLink() bool

+ func (m *Meta) ShouldList(global bool) bool

+ func (m *Meta) ShouldListAny() bool

type Page

+ func (p *Page) Terms(langIndex int, taxonomy string) contenthub.Pages

type Taxonomy

+ func (t *Taxonomy) IsTaxonomyPath(p string) bool

v0.0.12

Nov 20, 2024

v0.0.11

Nov 19, 2024

v0.0.10

Nov 19, 2024

v0.0.9

Nov 17, 2024

v0.0.8

Nov 10, 2024

v0.0.7

Nov 9, 2024

v0.0.6

Nov 9, 2024

v0.0.5

Nov 6, 2024

Changes in this version

type ContentHub

+ func (ch *ContentHub) GlobalRegularPages() contenthub.Pages

type Meta

+ Parameters maps.Params

+ Weight int

+ func (m *Meta) PageWeight() int

v0.0.4

Oct 21, 2024

v0.0.3

Oct 21, 2024

v0.0.2

Oct 21, 2024

v0.0.1

Oct 21, 2024

v0.0.0

Oct 21, 2024

Changes in this version

+ const Always

+ const DefaultBaseof

+ const DefaultFolder

+ const DefaultIndex

+ const DefaultList

+ const DefaultPage

+ const DefaultSection

+ const DefaultSitemap

+ const DefaultTaxonomy

+ const DefaultTerm

+ const InternalDefaultSitemap

+ const InternalFolder

+ const LayoutIndex

+ const LayoutList

+ const LayoutSection

+ const Link

+ const ListLocally

+ const Never

+ const PageHomeBase

+ const Sitemap

+ const StandalonePage404Base

+ const StandalonePageSitemapBase

+ const TaxonomyList

+ const TaxonomyTaxonomy

+ const TermList

+ const TermTerm

+ var InternalSummaryDividerPre = []byte("\n\n" + internalSummaryDividerBase + "\n\n")

+ type Cache struct

+ CacheContentRendered *dynacache.Partition[string, *stale.Value[valueobject.ContentSummary]]

+ CacheContentShortcodes *dynacache.Partition[string, *stale.Value[map[string]valueobject.ShortcodeRenderer]]

+ CacheContentSource *dynacache.Partition[string, *stale.Value[[]byte]]

+ CacheContentToRender *dynacache.Partition[string, *stale.Value[[]byte]]

+ CachePageSource *dynacache.Partition[string, contenthub.PageSource]

+ CachePageSources *dynacache.Partition[string, []contenthub.PageSource]

+ CachePages1 *dynacache.Partition[string, contenthub.Pages]

+ CachePages2 *dynacache.Partition[string, contenthub.Pages]

+ func (c *Cache) GetOrCreateResource(key string, f func() (contenthub.PageSource, error)) (contenthub.PageSource, error)

+ func (c *Cache) GetOrCreateResources(key string, f func() ([]contenthub.PageSource, error)) ([]contenthub.PageSource, error)

+ type Content struct

+ func NewContent(source []byte) *Content

+ func (c *Content) AddItems(item pageparser.Item)

+ func (c *Content) AddReplacement(val []byte, source pageparser.Item)

+ func (c *Content) AddShortcode(s *valueobject.Shortcode)

+ func (c *Content) PureContent() string

+ func (c *Content) RawContent() string

+ func (c *Content) SetSummaryDivider()

+ func (c *Content) SetSummaryTruncated()

+ type ContentHub struct

+ Fs contenthub.FsService

+ Log loggers.Logger

+ TemplateExecutor contenthub.Template

+ func (ch *ContentHub) CollectPages(exec contenthub.Template) error

+ func (ch *ContentHub) GetPageFromPath(path string) (contenthub.Page, error)

+ func (ch *ContentHub) GetPageSources(page contenthub.Page) ([]contenthub.PageSource, error)

+ func (ch *ContentHub) GlobalPages() contenthub.Pages

+ func (ch *ContentHub) ProcessPages(exec contenthub.Template) error

+ func (ch *ContentHub) RenderString(ctx context.Context, args ...any) (goTmpl.HTML, error)

+ func (ch *ContentHub) WalkPages(langIndex int, walker contenthub.WalkFunc) error

+ func (ch *ContentHub) WalkTaxonomies(langIndex int, walker contenthub.WalkTaxonomyFunc) error

+ type ContentProvider struct

+ func (c *ContentProvider) Content() (any, error)

+ func (c *ContentProvider) ContentSummary() (valueobject.ContentSummary, error)

+ func (c *ContentProvider) Summary() goTemplate.HTML

+ func (c *ContentProvider) TableOfContents() goTemplate.HTML

+ type ContentSpec struct

+ Converters contenthub.ConverterRegistry

+ func (c *ContentSpec) GetContentConvertProvider(name string) contenthub.ConverterProvider

+ func (c *ContentSpec) ResolveMarkup(in string) string

+ type Layout struct

+ type Meta struct

+ List string

+ func (m *Meta) Description() string

+ func (m *Meta) Params() maps.Params

+ type Output struct

+ func (o *Output) Build(convertProvider *ContentSpec, templateSvc contenthub.Template, ...) error

+ func (o *Output) Outputs(p *Page) ([]contenthub.PageOutput, error)

+ type Page struct

+ func (p *Page) AllTranslations() contenthub.Pages

+ func (p *Page) Eq(other contenthub.Page) bool

+ func (p *Page) IsAncestor(other contenthub.Page) bool

+ func (p *Page) IsBundled() bool

+ func (p *Page) IsHome() bool

+ func (p *Page) IsPage() bool

+ func (p *Page) IsSection() bool

+ func (p *Page) Kind() string

+ func (p *Page) Layouts() []string

+ func (p *Page) PageOutputs() ([]contenthub.PageOutput, error)

+ func (p *Page) Pages(langIndex int) contenthub.Pages

+ func (p *Page) Title() string

+ func (p *Page) Translations() contenthub.Pages

+ type PageBuilder struct

+ ConvertProvider *ContentSpec

+ LangSvc contenthub.LangService

+ Log loggers.Logger

+ MediaSvc contenthub.MediaService

+ PageMapper *PageMap

+ Section *Section

+ Standalone *Standalone

+ Taxonomy *Taxonomy

+ TaxonomySvc contenthub.TaxonomyService

+ TemplateSvc contenthub.Template

+ Term *Term

+ func (b *PageBuilder) Build() (contenthub.Page, error)

+ func (b *PageBuilder) BytesHandler() valueobject.ItemHandler

+ func (b *PageBuilder) FrontMatterHandler() valueobject.ItemHandler

+ func (b *PageBuilder) KindBuild() (contenthub.Page, error)

+ func (b *PageBuilder) ShortcodeHandler() valueobject.IterHandler

+ func (b *PageBuilder) SummaryHandler() valueobject.IterHandler

+ func (b *PageBuilder) WithSource(source *Source) *PageBuilder

+ type PageMap struct

+ Cache *Cache

+ Log loggers.Logger

+ PageBuilder *PageBuilder

+ func (m *PageMap) AddFi(f *valueobject.File) error

+ func (m *PageMap) Assemble() error

+ func (m *PageMap) InsertResourceNode(key string, node *PageTreesNode)

+ type PageTrees struct

+ ResourceTrees doctree.MutableTrees

+ TreePages *doctree.NodeShiftTree[*PageTreesNode]

+ TreePagesResources doctree.WalkableTrees[*PageTreesNode]

+ TreeResources *doctree.NodeShiftTree[*PageTreesNode]

+ TreeTaxonomyEntries *doctree.TreeShiftTree[*WeightedTermTreeNode]

+ func (t *PageTrees) CreateMutableTrees()

+ type PageTreesNode struct

+ type Section struct

+ Cache *Cache

+ FsSvc contenthub.FsService

+ func (s *Section) Assemble(pages *doctree.NodeShiftTree[*PageTreesNode], pb *PageBuilder) error

+ func (s *Section) CreateHome(pb *PageBuilder) error

+ type ShortcodeWithPage struct

+ Inner template.HTML

+ IsNamedParams bool

+ Name string

+ Ordinal int

+ Page contenthub.Page

+ Params any

+ Parent *ShortcodeWithPage

+ func (scp *ShortcodeWithPage) Get(key any) any

+ func (scp *ShortcodeWithPage) InnerDeindent() template.HTML

+ func (scp *ShortcodeWithPage) Position() text.Position

+ func (scp *ShortcodeWithPage) Ref(args map[string]any) (string, error)

+ func (scp *ShortcodeWithPage) RelRef(args map[string]any) (string, error)

+ func (scp *ShortcodeWithPage) Scratch() *maps.Scratch

+ func (scp *ShortcodeWithPage) Unwrapv() any

+ type Source struct

+ type SourceShifter struct

+ func (s *SourceShifter) Delete(n *PageTreesNode, dimension doctree.Dimension) (bool, bool)

+ func (s *SourceShifter) ForEachInDimension(n *PageTreesNode, d int, f func(*PageTreesNode) bool)

+ func (s *SourceShifter) Insert(old, new *PageTreesNode) *PageTreesNode

+ func (s *SourceShifter) InsertInto(old, new *PageTreesNode, dimension doctree.Dimension) *PageTreesNode

+ func (s *SourceShifter) Shift(n *PageTreesNode, dimension doctree.Dimension, exact bool) (*PageTreesNode, bool, doctree.DimensionFlag)

+ type Standalone struct

+ Cache *Cache

+ FsSvc contenthub.FsService

+ func (s *Standalone) Assemble(pages *doctree.NodeShiftTree[*PageTreesNode], pb *PageBuilder) error

+ type Taxonomy struct

+ Cache *Cache

+ FsSvc contenthub.FsService

+ Views []contenthub.Taxonomy

+ func (t *Taxonomy) Assemble(pages *doctree.NodeShiftTree[*PageTreesNode], pb *PageBuilder) error

+ func (t *Taxonomy) IsZero(v contenthub.Taxonomy) bool

+ func (t *Taxonomy) PluralTreeKey(plural string) string

+ type TaxonomyPage struct

+ type Term struct

+ Cache *Cache

+ FsSvc contenthub.FsService

+ Terms map[string][]string

+ func (t *Term) Assemble(pages *doctree.NodeShiftTree[*PageTreesNode], ...) error

+ type TermPage struct

+ type Title struct

+ Style TitleStyle

+ func (t *Title) CreateTitle(raw string) string

+ type TitleStyle string

+ const StyleAP

+ const StyleNone

+ type WeightedTermTreeNode struct

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL