Listitem render hook

docs/content/en/templates/render-hooks.md

@@ -25,6 +25,8 @@ The hook kinds currently supported are:
 * `link`
 * `heading`
 * `codeblock`{{< new-in "0.93.0" >}}
+* `list`{{< new-in "0.99.0" >}}
+* `listitem`{{< new-in "0.99.0" >}}
 
 You can define [Output-Format-](/templates/output-formats) and [language-](/content-management/multilingual/)specific templates if needed. Your `layouts` folder may look like this:
 
@@ -179,3 +181,98 @@ Page
 
 Position
 : Useful in error logging as it prints the filename and position (linenumber, column), e.g. `{{ errorf "error in code block: %s" .Position }}`.
+
+## Render Hooks for Lists and List Items
+
+{{< new-in "0.99.0" >}}
+
+You can add a hook template for lists and list items e.g. for different output types
+
+```goat { class="black f7" }
+layouts
+└── _default
+    └── _markup
+        └── render-listitem.html
+        └── render-listitem.json
+        └── render-list.html
+        └── render-list.json
+```
+
+The `render-list` template will receive this context:
+
+Page
+: The [Page](/variables/page/) being rendered.
+
+Text
+: The rendered (HTML) list content.
+
+PlainText
+: The plain variant of the above.
+
+IsOrdered (bool)
+: If this is an ordered list.
+
+Parent 
+: The Parent node of the list.
+
+Attributes (map) {{< new-in "0.82.0" >}}
+: A map of attributes (e.g. `id`, `class`)
+
+
+The `render-listitem` template will receive this context:
+
+Page
+: The [Page](/variables/page/) being rendered.
+
+Text
+: The rendered (HTML) list content.
+
+PlainText
+: The plain variant of the above.
+
+IsFirst (bool)
+: If this is the first item in the list.
+
+IsLast (bool)
+: If this is the last item in the list.
+
+Parent 
+: The Parent node of the item, the list node.
+
+### ListItem rendered as JSON-LD example:
+
+```md
+1. Do This
+2. Then That
+```
+
+Here is a code example for how the render-listitem.json template could look:
+
+{{< code file="layouts/_default/_markup/render-list.html" >}}
+{{- if eq .Parent.IsOrdered true -}}
+{
+    "@type": "HowToStep",
+    "text": "{{ .Text | plainify}}"
+}{{ if not .IsLast }},{{ end }}{{ print "\n"}}
+{{- else -}}
+{{- if not .IsLast -}}
+    {{ printf "\"%s\",\n" .Text | plainify}}
+{{- else -}}
+    {{ printf "\"%s\"" .Text | plainify}}
+{{- end -}}
+{{- end -}}
+{{< /code >}}
+
+
+The rendered html will be
+
+```js
+{
+    "@type": "HowToStep",
+    "text": "Do This"
+},
+{
+    "@type": "HowToStep",
+    "text": "Then That"
+}
+```

hugolib/content_render_hooks_test.go

@@ -97,7 +97,8 @@ 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-list.html", `LIST: {{ .Text | safeHTML }}|{{ .Attributes }}|{{ .IsOrdered }} `)
+	b.WithTemplatesAdded("_default/_markup/render-listitem.html", `LISTITEM: {{ .Text | safeHTML }} {{ .IsFirst }} {{ .IsLast }} `)
 	b.WithContent("customview/p1.md", `---
 title: Custom View
 ---
@@ -195,6 +196,21 @@ title: Doc With Heading
 
 # Docs lvl 1
 
+`, "blog/p9.md", `---
+title: With List Items
+---
+- Dog
+- Cat
+- Mouse **Fat**
+- Bird
+{.animal}
+`, "blog/p10.md", `---
+title: With Ordered List
+---
+1. Car
+2. Boat
+3. Plane
+{.transportation}
 `,
 	)
 
@@ -209,7 +225,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, 47)
 
 	b.AssertFileContent("public/blog/p1/index.html", `
 Cool Page|https://www.google.com|Title: Google's Homepage|Text: First Link|END
@@ -264,6 +280,14 @@ 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 <strong>Fat</strong>")
+	b.AssertFileContent("public/blog/p9/index.html", "class:animal")
+
+	b.AssertFileContent("public/blog/p10/index.html", "LIST:")
+	b.AssertFileContent("public/blog/p10/index.html", "class:transportation")
 }
 
 func TestRenderHooksDeleteTemplate(t *testing.T) {

hugolib/page__per_output.go

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

hugolib/site.go

@@ -1810,6 +1810,14 @@ func (hr hookRendererTemplate) RenderCodeblock(cctx context.Context, w hugio.Fle
 	return hr.templateHandler.ExecuteWithContext(cctx, hr.templ, w, ctx)
 }
 
+func (hr hookRendererTemplate) RenderListItem(cctx context.Context, w io.Writer, ctx hooks.ListItemContext) error {
+	return hr.templateHandler.ExecuteWithContext(cctx, hr.templ, w, ctx)
+}
+
+func (hr hookRendererTemplate) RenderList(cctx context.Context, w io.Writer, ctx hooks.ListContext) error {
+	return hr.templateHandler.ExecuteWithContext(cctx, hr.templ, w, ctx)
+}
+
 func (hr hookRendererTemplate) ResolvePosition(ctx any) text.Position {
 	return hr.resolvePosition(ctx)
 }

markup/converter/hooks/hooks.go

@@ -124,6 +124,35 @@ type HeadingRenderer interface {
 	identity.Provider
 }
 
+type ListItemContext interface {
+	Page() interface{}
+	Text() hstring.RenderedString
+	PlainText() string
+	IsFirst() bool
+	IsLast() bool
+	Parent() interface{}
+}
+
+type ListItemRenderer interface {
+	RenderListItem(cctx context.Context, w io.Writer, ctx ListItemContext) error
+	identity.Provider
+}
+
+type ListContext interface {
+	Page() interface{}
+	Text() hstring.RenderedString
+	PlainText() string
+	IsOrdered() bool
+	Parent() interface{}
+
+	AttributesProvider
+}
+
+type ListRenderer interface {
+	RenderList(cctx context.Context, 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
@@ -139,6 +168,8 @@ const (
 	ImageRendererType
 	HeadingRendererType
 	CodeBlockRendererType
+	ListItemRendererType
+	ListRendererType
 )
 
 type GetRendererFunc func(t RendererType, id any) any