List Render Hook

hugolib/page__per_output.go

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

hugolib/site.go

@@ -1808,6 +1808,10 @@ func (hr hookRendererTemplate) RenderListItem(w io.Writer, ctx hooks.ListItemCon
 	return hr.templateHandler.Execute(hr.templ, w, ctx)
 }
 
+func (hr hookRendererTemplate) RenderList(w io.Writer, ctx hooks.ListContext) 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

@@ -107,6 +107,21 @@ type ListItemRenderer interface {
 	identity.Provider
 }
 
+type ListContext interface {
+	Page() interface{}
+	Text() hstring.RenderedString
+	PlainText() string
+
+	Parent() interface{}
+
+	AttributesProvider
+}
+
+type ListRenderer interface {
+	RenderList(w io.Writer, ctx ListContext) 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
@@ -123,6 +138,7 @@ const (
 	HeadingRendererType
 	CodeBlockRendererType
 	ListItemRendererType
+	ListRendererType
 )
 
 type GetRendererFunc func(t RendererType, id any) any

markup/goldmark/render_hooks.go

@@ -15,6 +15,7 @@ package goldmark
 
 import (
 	"bytes"
+	"fmt"
 	"strings"
 
 	"github.com/gohugoio/hugo/common/types/hstring"
@@ -141,6 +142,30 @@ func (ctx listItemContext) Parent() interface{} {
 	return ctx.parent
 }
 
+type listContext struct {
+	page      interface{}
+	text      hstring.RenderedString
+	plainText string
+	parent    interface{}
+	*attributes.AttributesHolder
+}
+
+func (ctx listContext) Page() interface{} {
+	return ctx.page
+}
+
+func (ctx listContext) Text() hstring.RenderedString {
+	return ctx.text
+}
+
+func (ctx listContext) PlainText() string {
+	return ctx.plainText
+}
+
+func (ctx listContext) Parent() interface{} {
+	return ctx.parent
+}
+
 type hookedRenderer struct {
 	linkifyProtocol []byte
 	html.Config
@@ -157,6 +182,7 @@ func (r *hookedRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
 	reg.Register(ast.KindImage, r.renderImage)
 	reg.Register(ast.KindHeading, r.renderHeading)
 	reg.Register(ast.KindListItem, r.renderListItem)
+	reg.Register(ast.KindList, r.renderList)
 }
 
 func (r *hookedRenderer) renderImage(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
@@ -506,6 +532,75 @@ func (r *hookedRenderer) renderListItemDefault(w util.BufWriter, source []byte,
 	return ast.WalkContinue, nil
 }
 
+func (r *hookedRenderer) renderListDefault(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
+	n := node.(*ast.List)
+	tag := "ul"
+	if n.IsOrdered() {
+		tag = "ol"
+	}
+	if entering {
+		_ = w.WriteByte('<')
+		_, _ = w.WriteString(tag)
+		if n.IsOrdered() && n.Start != 1 {
+			fmt.Fprintf(w, " start=\"%d\"", n.Start)
+		}
+		if n.Attributes() != nil {
+			html.RenderAttributes(w, n, html.ListAttributeFilter)
+		}
+		_, _ = w.WriteString(">\n")
+	} else {
+		_, _ = w.WriteString("</")
+		_, _ = w.WriteString(tag)
+		_, _ = w.WriteString(">\n")
+	}
+	return ast.WalkContinue, nil
+}
+
+func (r *hookedRenderer) renderList(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) {
+	n := node.(*ast.List)
+	n.FirstChild()
+	var hli hooks.ListRenderer
+
+	ctx, ok := w.(*render.Context)
+	if ok {
+		h := ctx.RenderContext().GetRenderer(hooks.ListItemRendererType, nil)
+		ok = h != nil
+		if ok {
+			hli = h.(hooks.ListRenderer)
+		}
+	}
+
+	if !ok {
+		return r.renderListDefault(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.RenderList(
+		w,
+		listItemContext{
+			page:             ctx.DocumentContext().Document,
+			text:             hstring.RenderedString(text),
+			plainText:        string(n.Text(source)),
+			parent:           n.Parent(),
+			AttributesHolder: attributes.New(n.Attributes(), attributes.AttributesOwnerGeneral),
+		},
+	)
+
+	ctx.AddIdentity(hli)
+
+	return ast.WalkContinue, err
+	//return r.renderListDefault(w, source, node, entering)
+}
+
 type links struct {
 	cfg goldmark_config.Config
 }