<details> not considered for search results

[CSC-Sendance]

Hi,

We make relatively heavy use of the <details> tag (see w3schools) even in a nested fashion, e.g.:

<details>
<summary>
heading 1
</summary>
    <details>
        <summary>heading 2 that only is visible when heading 1 was clicked.</summary>
        <p>
       contents that are only visible when heading 1 and then heading 2 were clicked.
        </p>
    </details>
</details>

even after cleaning and building the docusaurus build, it appears only top level details summaries (i.e. heading 1) are included in the search results. No contents or heading2s etc. are considered in the search results.

I inspected the HTML for a bit and the contents are in the HTML defined already, even without collapsing.

Any ideas on how to resolve this (beyond not using the details tag) or is it a bug?

package-lock.json

      "dependencies": {
        "@docusaurus/core": "^3.7.0",
        "@docusaurus/preset-classic": "^3.7.0",
        "@easyops-cn/docusaurus-search-local": "^0.46.1",
        "@fontsource/manrope": "5.0.20",
        "@iconify/react": "^5.2.0",
        "@mdx-js/react": "3.0.1",
        "clsx": "2.1.1",
        "prism-react-renderer": "2.3.1",
        "react": "18.3.1",
        "react-dom": "18.3.1",
        "react-helmet-async": "^2.0.5"
      },

docusaurus.config.ts

  themes: [
    [
      "@easyops-cn/docusaurus-search-local",
      {
        hashed: true,
        indexPages: true,
        language: ["en"],
        highlightSearchTermsOnTargetPage: true,
        explicitSearchResultPath: true,
      },
    ],
  ],

[weareoutman]

Dost it show ... contents ... when searching content? (the keyword that appears in your level 2 details)

[CSC-Sendance]

Dost it show ... contents ... when searching content? (the keyword that appears in your level 2 details)

No it does not - see example screenshot.

[weareoutman]

Does it show any other results in that FAQs page when searching keywords other than in <details>? E.g., search problem

[CSC-Sendance]

Does it show any other results in that FAQs page when searching keywords other than in

Details

? E.g., search problem

yes, that works.

edit: for some reason, this first result is also duplicated

[weareoutman]

I can't reproduce your problem using your html snippet. Can you share a repro link?

Here's my local test:

[CSC-Sendance]

I can't reproduce your problem using your html snippet. Can you share a repro link?

Here's my local test:

Hey. I can't provide the repo directly but may setup a minimal working example. What I just found: Adding an actual markdown heading (e.g. ### heading 1) breaks the search results for all the <details> tag and its sub-<details> . Without this heading, the contents are searchable (although the details also don't expand when selecting the search results.. but I guess that's more of a future improvement rather than a bugfix).

[weareoutman]

Can't reproduce it by adding markdown headings, either.

[CSC-Sendance]

Can't reproduce it by adding markdown headings, either.

Hi, sorry for the late reply - things are a bit busy here. Tagging my colleague too, because I won't be working much longer on this project: @mdi-sendance

I have set up two example projects (Typescript and default Javascript) with docusaurus and this "theme" installed with the default commands. Additionally, on both projects, I removed all docs pages but "intro" and the blog (to avoid cluttering the search results). Here is the repo with both: https://github.com/CSC-Sendance/docuissue-searchlocal

so, for setup, npx create-docusaurus@latest my-website classic and npx create-docusaurus@latest my-website classic --typescript was respectively used. Followed by separate npm install --save @easyops-cn/docusaurus-search-local

after running both projects with..

npm run clear
npm run build
npm run serve

... the issue appears again: as soon as a markdown heading ## heading is used in the "summary" of the details, search results break for all details (even the second one without heading).

[weareoutman]

I see, our search plugin expects headings to be appeared at top level of your markdown.

You can fix the issue by adding any h2/h3 headings before your <details>.

Or you can just remove any h2/h3 headings in your <details>, and try using css to style it instead.

[CSC-Sendance]

I see, our search plugin expects headings to be appeared at top level of your markdown.

You can fix the issue by adding any h2/h3 headings before your <details>.

Or you can just remove any h2/h3 headings in your <details>, and try using css to style it instead.

Ok thanks - is this intended behavior? It sounds very odd for me.

edit: we changed the structure of the page where headings are extracted from the details, as suggested. This works around the issue.

[weareoutman]

I would not say it's intended, but It's the current assumption, and you're the first one and currently only one to report this issue :).

Will look into it later to see if we can handle such case.

[CSC-Sendance]

I would not say it's intended, but It's the current assumption, and you're the first one and currently only one to report this issue :).

Will look into it later to see if we can handle such case.

Thanks for your awesome support though!

For other people having this issue, we ultimately went with the following:

## SectionName

    <details>
    <summary><span id="faq_sectionabbrev_questionabbrev">Question / issue description</span></summary>
        <p>
        Answer / workaround description
        </p>
    </details

i.e. separated sections out of nested details and used spans to create anchors for direct linking to the "Details" object. With some scripting, one would probably also get it to open up when the link is used ;)