ListItem Render Hook

hugolib/content_render_hooks_test.go

@@ -98,7 +98,7 @@ Inner Block: {{ .Inner | .Page.RenderString (dict "display" "block" ) }}
 	b.WithTemplatesAdded("_default/_markup/render-image.html", `IMAGE: {{ .Page.Title }}||{{ .Destination | safeURL }}|Title: {{ .Title | safeHTML }}|Text: {{ .Text | safeHTML }}|END`)
 	b.WithTemplatesAdded("_default/_markup/render-heading.html", `HEADING: {{ .Page.Title }}||Level: {{ .Level }}|Anchor: {{ .Anchor | safeURL }}|Text: {{ .Text | safeHTML }}|Attributes: {{ .Attributes }}|END`)
 	b.WithTemplatesAdded("docs/_markup/render-heading.html", `Docs Level: {{ .Level }}|END`)
-
+	b.WithTemplatesAdded("_default/_markup/render-listitem.html", `LISTITEM: {{ .Text | safeHTML }} {{ .Attributes }} {{ .FirstChild }} {{ .Parent }}`)
 	b.WithContent("customview/p1.md", `---
 title: Custom View
 ---
@@ -196,6 +196,13 @@ title: Doc With Heading
 
 # Docs lvl 1
 
+`, "blog/p9.md", `---
+title: With List Items
+---
+- Dog
+- Cat
+- Mouse
+- Bird{ parrot=true }
 `,
 	)
 
@@ -210,7 +217,7 @@ title: No Template
 	}
 	counters := &testCounters{}
 	b.Build(BuildCfg{testCounters: counters})
-	b.Assert(int(counters.contentRenderCounter), qt.Equals, 45)
+	b.Assert(int(counters.contentRenderCounter), qt.Equals, 46)
 
 	b.AssertFileContent("public/blog/p1/index.html", `
 Cool Page|https://www.google.com|Title: Google's Homepage|Text: First Link|END
@@ -265,6 +272,10 @@ SHORT3|
 
 	// https://github.com/gohugoio/hugo/issues/7349
 	b.AssertFileContent("public/docs/p8/index.html", "Docs Level: 1")
+
+	b.AssertFileContent("public/blog/p9/index.html", "LISTITEM: Dog")
+	b.AssertFileContent("public/blog/p9/index.html", "LISTITEM: Cat")
+	b.AssertFileContent("public/blog/p9/index.html", "LISTITEM: Mouse")
 }
 
 func TestRenderHooksDeleteTemplate(t *testing.T) {

hugolib/page__per_output.go

@@ -491,6 +491,8 @@ func (p *pageContentOutput) initRenderHooks() error {
 						layoutDescriptor.KindVariants = lang
 					}
 				}
+			case hooks.ListItemRendererType:
+				layoutDescriptor.Kind = "render-listitem"
 			}
 
 			getHookTemplate := func(f output.Format) (tpl.Template, bool) {

hugolib/site.go

@@ -1804,6 +1804,10 @@ func (hr hookRendererTemplate) RenderCodeblock(w hugio.FlexiWriter, ctx hooks.Co
 	return hr.templateHandler.Execute(hr.templ, w, ctx)
 }
 
+func (hr hookRendererTemplate) RenderListItem(w io.Writer, ctx hooks.ListItemContext) error {
+	return hr.templateHandler.Execute(hr.templ, w, ctx)
+}
+
 func (hr hookRendererTemplate) ResolvePosition(ctx any) text.Position {
 	return hr.resolvePosition(ctx)
 }

markup/converter/hooks/hooks.go

@@ -91,6 +91,22 @@ type HeadingRenderer interface {
 	identity.Provider
 }
 
+type ListItemContext interface {
+	Page() interface{}
+	Text() hstring.RenderedString
+	PlainText() string
+	Offset() int
+	FirstChild() interface{}
+	Parent() interface{}
+
+	AttributesProvider
+}
+
+type ListItemRenderer interface {
+	RenderListItem(w io.Writer, ctx ListItemContext) error
+	identity.Provider
+}
+
 // ElementPositionResolver provides a way to resolve the start Position
 // of a markdown element in the original source document.
 // This may be both slow and approximate, so should only be
@@ -106,6 +122,7 @@ const (
 	ImageRendererType
 	HeadingRendererType
 	CodeBlockRendererType
+	ListItemRendererType
 )
 
 type GetRendererFunc func(t RendererType, id any) any

markup/goldmark/render_hooks.go

@@ -107,6 +107,40 @@ func (ctx headingContext) PlainText() string {
 	return ctx.plainText
 }
 
+type listItemContext struct {
+	page       interface{}
+	text       hstring.RenderedString
+	plainText  string
+	offset     int
+	firstChild interface{}
+	parent     interface{}
+	*attributes.AttributesHolder
+}
+
+func (ctx listItemContext) Page() interface{} {
+	return ctx.page
+}
+
+func (ctx listItemContext) Text() hstring.RenderedString {
+	return ctx.text
+}
+
+func (ctx listItemContext) PlainText() string {
+	return ctx.plainText
+}
+
+func (ctx listItemContext) Offset() int {
+	return ctx.offset
+}
+
+func (ctx listItemContext) FirstChild() interface{} {
+	return ctx.firstChild
+}
+
+func (ctx listItemContext) Parent() interface{} {
+	return ctx.parent
+}
+
 type hookedRenderer struct {
 	linkifyProtocol []byte
 	html.Config
@@ -122,6 +156,7 @@ func (r *hookedRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
 	reg.Register(ast.KindAutoLink, r.renderAutoLink)
 	reg.Register(ast.KindImage, r.renderImage)
 	reg.Register(ast.KindHeading, r.renderHeading)
+	reg.Register(ast.KindListItem, r.renderListItem)
 }
 
 func (r *hookedRenderer) renderImage(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
@@ -410,6 +445,67 @@ func (r *hookedRenderer) renderHeadingDefault(w util.BufWriter, source []byte, n
 	return ast.WalkContinue, nil
 }
 
+func (r *hookedRenderer) renderListItem(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
+	n := node.(*ast.ListItem)
+	n.FirstChild()
+	var hli hooks.ListItemRenderer
+
+	ctx, ok := w.(*render.Context)
+	if ok {
+		h := ctx.RenderContext().GetRenderer(hooks.ListItemRendererType, nil)
+		ok = h != nil
+		if ok {
+			hli = h.(hooks.ListItemRenderer)
+		}
+	}
+
+	if !ok {
+		return r.renderListItemDefault(w, source, node, entering)
+	}
+
+	if entering {
+		// Store the current pos so we can capture the rendered text.
+		ctx.PushPos(ctx.Buffer.Len())
+		return ast.WalkContinue, nil
+	}
+
+	pos := ctx.PopPos()
+	text := ctx.Buffer.Bytes()[pos:]
+	ctx.Buffer.Truncate(pos)
+
+	err := hli.RenderListItem(
+		w,
+		listItemContext{
+			page:             ctx.DocumentContext().Document,
+			text:             hstring.RenderedString(text),
+			plainText:        string(n.Text(source)),
+			offset:           int(n.Offset),
+			firstChild:       n.FirstChild(),
+			parent:           n.Parent(),
+			AttributesHolder: attributes.New(n.Attributes(), attributes.AttributesOwnerGeneral),
+		},
+	)
+
+	ctx.AddIdentity(hli)
+
+	return ast.WalkContinue, err
+}
+
+func (r *hookedRenderer) renderListItemDefault(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) {
+	if entering {
+		_, _ = w.WriteString("<li>")
+		fc := n.FirstChild()
+		if fc != nil {
+			if _, ok := fc.(*ast.TextBlock); !ok {
+				_ = w.WriteByte('\n')
+			}
+		}
+	} else {
+		_, _ = w.WriteString("</li>\n")
+	}
+	return ast.WalkContinue, nil
+}
+
 type links struct {
 	cfg goldmark_config.Config
 }