DOC-6122 first working ToC metadata format

Author: andy-stark-redis

layouts/_default/section.md

@@ -16,7 +16,8 @@
   "key_specs": {{ .Params.key_specs | jsonify }}{{ end }}{{ if .Params.topics }},
   "topics": {{ .Params.topics | jsonify }}{{ end }}{{ if .Params.relatedPages }},
   "relatedPages": {{ .Params.relatedPages | jsonify }}{{ end }}{{ if .Params.scope }},
-  "scope": {{ .Params.scope | jsonify }}{{ end }}
+  "scope": {{ .Params.scope | jsonify }}{{ end }},
+  "tableOfContents": {{ partial "toc-json-regex.html" . }}
 }
 ```
 

layouts/_default/single.md

@@ -16,7 +16,8 @@
   "key_specs": {{ .Params.key_specs | jsonify }}{{ end }}{{ if .Params.topics }},
   "topics": {{ .Params.topics | jsonify }}{{ end }}{{ if .Params.relatedPages }},
   "relatedPages": {{ .Params.relatedPages | jsonify }}{{ end }}{{ if .Params.scope }},
-  "scope": {{ .Params.scope | jsonify }}{{ end }}
+  "scope": {{ .Params.scope | jsonify }}{{ end }},
+  "tableOfContents": {{ partial "toc-json-regex.html" . }}
 }
 ```
 

layouts/partials/ai-metadata-body.html

@@ -37,5 +37,8 @@
   {{- $metadata = merge $metadata (dict "scope" .Params.scope) -}}
 {{- end -}}
 {{- $json := $metadata | jsonify -}}
+{{- $toc := partial "toc-json-regex.html" . -}}
+{{- /* Manually insert tableOfContents into JSON string */ -}}
+{{- $json = $json | replaceRE `}$` (printf `,"tableOfContents":%s}` $toc) -}}
 {{- printf `<div hidden data-redis-metadata="page">%s</div>` $json | safeHTML -}}
 

layouts/partials/ai-metadata.html

@@ -37,5 +37,8 @@
   {{- $metadata = merge $metadata (dict "scope" .Params.scope) -}}
 {{- end -}}
 {{- $json := $metadata | jsonify -}}
+{{- $toc := partial "toc-json-regex.html" . -}}
+{{- /* Manually insert tableOfContents into JSON string */ -}}
+{{- $json = $json | replaceRE `}$` (printf `,"tableOfContents":%s}` $toc) -}}
 {{- printf `<script type="application/json" data-ai-metadata>%s</script>` $json | safeHTML -}}
 

layouts/partials/toc-json-regex.html

@@ -0,0 +1,36 @@
+{{/* Convert Hugo's HTML table of contents to JSON using regex substitutions */}}
+{{/* Input: page object */}}
+{{/* Output: JSON structure representing the table of contents */}}
+
+{{ $toc := .TableOfContents }}
+
+{{/* Remove the nav wrapper and all newlines/extra whitespace */}}
+{{ $toc = $toc | replaceRE "<nav[^>]*>" "" }}
+{{ $toc = $toc | replaceRE "</nav>" "" }}
+{{ $toc = $toc | replaceRE "\\n\\s*" "" }}
+
+{{/* Step 1: Replace <ul> with opening bracket for children array */}}
+{{ $toc = $toc | replaceRE "<ul>" "[" }}
+{{ $toc = $toc | replaceRE "</ul>" "]" }}
+
+{{/* Step 2: Replace <li><a href="#ID">TITLE</a> with {"id":"ID","title":"TITLE" */}}
+{{ $toc = $toc | replaceRE "<li><a href=\"#([^\"]+)\">([^<]+)</a>" "{\"id\":\"$1\",\"title\":\"$2\"" }}
+
+{{/* Step 3: Replace </li> with } */}}
+{{ $toc = $toc | replaceRE "</li>" "}" }}
+
+{{/* Step 4: Handle nested structure - replace ][ with ],[ (sibling arrays) */}}
+{{ $toc = $toc | replaceRE "\\]\\[" "],[" }}
+
+{{/* Step 4b: Handle nested structure - replace [  with ,"children":[ (child arrays) */}}
+{{ $toc = $toc | replaceRE "\"\\[" "\",\"children\":[" }}
+
+{{/* Step 5: Add commas between sibling objects - replace }{ with },{ */}}
+{{ $toc = $toc | replaceRE "\\}\\{" "},{" }}
+
+{{/* Step 6: Wrap the entire structure */}}
+{{ $toc = print "{\"sections\":" $toc "}" }}
+
+{{/* Output the JSON - use safeHTML to prevent quote escaping */}}
+{{ $toc | safeHTML }}
+