Search results linking to wrong spot on page

[ualbelac]

I enabled the search box but results. Search results seem correct, but display the wrong heading and link to the wrong heading. For some reason everything is showing as linked to the same incorrect H2 heading. Any ideas of why this is happening or how to resolve it? I have all search features with default parameters.

[imfing]

hey can you provide more details or provide a minimal example to reproduce this?

[ldez]

I have the same behavior: inside en.search-data.json, there are all h2, but only one is not empty.
In my context, it seems related to the fact that I generate the h2 inside a shortcode that uses data.

For now, I don't understand if it is related to shortcodes or to the fact of using data (slow loading?).

It seems that it's always the latest h2 in the page.

{
  "/docs/linters/configuration/": {
    "data": {
      "": "",
      "arangolint#arangolint": "",
      "asasalint#asasalint": "",
      "asciicheck#asciicheck": "",
      "bidichk#bidichk": "",
      "bodyclose#bodyclose": "",
      "zerologlint#zerologlint": "xxxx xxxxxx"
    },
    "title": "Settings"
  }
}

I don't have a minimal reproducible example for now, but I will try to create one.

[imfing]

Thanks for the thorough analysis.

fragments.html uses the raw content to extract headers and body text for the search index.

In your case, running RenderShortcodes before parsing might be a more robust long-term solution.

[ldez]

Thank you for the answer.

I don't understand where to use RenderShortcodes.
Is it inside fragments.html?

RenderShortcodes returns a template.HTML and not a string like RawContent, and RawContent is a method of Page, so it feels like I cannot use it as a replacement (I tried it).

🤔 I may have missed something

Minimal reproducible example (with official fragments.html):

content/docs/configuration/cli.md

---
title: Command-Line
weight: 1
---

## `config`

{{< cli-output cmd="config" >}}

## `custom`

{{< cli-output cmd="custom" >}}

## `version`

{{< cli-output cmd="version" >}}

## `completion`

{{< cli-output cmd="completion" >}}

layouts/_shortcodes/cli-output.html

{{- $cmdName := .Get "cmd" -}}
{{- $section := .Get "section" -}}

Content: {{ $cmdName }} {{ $section }}

en.search-data.json

$ cat public/en.search-data.json| jq '."/docs/configuration/cli/"'
{
  "data": {
    "": "",
    "completion#<code>completion</code>": "config Content: config custom Content: custom version Content: version completion Content: completion ",
    "config#<code>config</code>": "",
    "custom#<code>custom</code>": "",
    "version#<code>version</code>": ""
  },
  "title": "Command-Line"
}

[ldez]

Without shortcode:

content/docs/configuration/cli.md

---
title: Command-Line
weight: 1
---

## `config`

aaaaaaaaa

## `custom`

bbbbbbbbbbbbb

## `version`

ccccccccccccc

## `completion`

ddddddddddddd

en.search-data.json

$ cat public/en.search-data.json| jq '."/docs/configuration/cli/"'
{
  "data": {
    "": "",
    "completion#<code>completion</code>": "config aaaaaaaaa\ncustom bbbbbbbbbbbbb\nversion ccccccccccccc\ncompletion ddddddddddddd",
    "config#<code>config</code>": "",
    "custom#<code>custom</code>": "",
    "version#<code>version</code>": ""
  },
  "title": "Command-Line"
}

The first problem is with backticks:

• The headings (ex: $h2.Title) have this form ## <code>config</code>
• Inside $page.RawContent, the headings have this form ## `config`

So {{ $parts := split $content (printf "\n%s\n" $headingTitle) }} cannot work.

{{ warnf (debug.Dump $page.Fragments.Headings) }}

[
  {
    "ID": "",
    "Level": 0,
    "Title": "",
    "Headings": [
      {
        "ID": "config",
        "Level": 2,
        "Title": "\u003ccode\u003econfig\u003c/code\u003e",
        "Headings": null
      },
      {
        "ID": "custom",
        "Level": 2,
        "Title": "\u003ccode\u003ecustom\u003c/code\u003e",
        "Headings": null
      },
      {
        "ID": "version",
        "Level": 2,
        "Title": "\u003ccode\u003eversion\u003c/code\u003e",
        "Headings": null
      },
      {
        "ID": "completion",
        "Level": 2,
        "Title": "\u003ccode\u003ecompletion\u003c/code\u003e",
        "Headings": null
      }
    ]
  }
]

{{ warnf (debug.Dump $page.RawContent) }}

"\n## `config`\n\naaaaaaaaa\n\n## `custom`\n\nbbbbbbbbbbbbb\n\n## `version`\n\nccccccccccccc\n\n## `completion`\n\nddddddddddddd\n"

RenderShortcodes will not change this behavior, because there are no shortcodes.

[ldez]

My new patch (this is a simplification of the previous one):

diff --git i/docs/layouts/_partials/utils/fragments.html w/docs/layouts/_partials/utils/fragments.html
index ae656f141..b47e59752 100644
--- i/docs/layouts/_partials/utils/fragments.html
+++ w/docs/layouts/_partials/utils/fragments.html
@@ -12,15 +12,15 @@
   {{ else }}
     {{ $headingKeys = $headingKeys | append (printf "%s#%s" $h1.ID $h1.Title) }}
   {{ end }}
-  {{ $headingTitles = $headingTitles | append (printf "# %s" $h1.Title) }}
+  {{ $headingTitles = $headingTitles | append (printf "<h1>%s" $h1.Title) }}
 
   {{ range $h2 := $h1.Headings }}
     {{ $headingKeys = $headingKeys | append (printf "%s#%s" $h2.ID $h2.Title) }}
-    {{ $headingTitles = $headingTitles | append (printf "## %s" $h2.Title) }}
+    {{ $headingTitles = $headingTitles | append (printf "<h2>%s" $h2.Title) }}
   {{ end }}
 {{ end }}
 
-{{ $content := $page.RawContent }}
+{{ $content := $page.Content | htmlUnescape }}
 {{ $len := len $headingKeys }}
 {{ $data := dict }}
 
@@ -36,14 +36,14 @@
       {{ $headingTitle := index $headingTitles $i }}
 
       {{ if eq $i 0 }}
-        {{ $data = $data | merge (dict $headingKey ($content | $page.RenderString | plainify | htmlUnescape | chomp)) }}
+        {{ $data = $data | merge (dict $headingKey ($content | plainify | htmlUnescape | chomp)) }}
       {{ else }}
-        {{ $parts := split $content (printf "\n%s\n" $headingTitle) }}
+        {{ $parts := split $content (printf "%s" $headingTitle) }}
         {{ $lastPart := index $parts (sub (len $parts) 1) }}
 
-        {{ $data = $data | merge (dict $headingKey ($lastPart | $page.RenderString | plainify | htmlUnescape | chomp)) }}
+        {{ $data = $data | merge (dict $headingKey ($lastPart | plainify | htmlUnescape | chomp)) }}
         {{ $content = strings.TrimSuffix $lastPart $content }}
-        {{ $content = strings.TrimSuffix (printf "\n%s\n" $headingTitle) $content }}
+        {{ $content = strings.TrimSuffix (printf "%s" $headingTitle) $content }}
       {{ end }}
     {{ end }}
   {{ end }}

If you agree with the patch, I can open a PR with it.

[imfing]

I don't understand where to use RenderShortcodes. Is it inside fragments.html?
RenderShortcodes returns a template.HTML and not a string like RawContent, and RawContent is a method of Page, so it feels like I cannot use it as a replacement (I tried it).

appreciate the detailed replies 👍

all good, I misread previous comments.

My new patch (this is a simplification of the previous one):
If you agree with the patch, I can open a PR with it.

did a quick look and it looks great, please go ahead and make a PR 🙏