Getting search box to include blog posts

[cameronelliott]

Is there some way to get the search-box to include blog articles?
As far as I can tell, the search box doesn't seem to be including the blog articles.

Thanks,
Cameron

[h-enk]

Hey @cameronelliott, nice one!

1. In ./assets/js/index.js, replace {{ $list := (where .Site.Pages "Section" "docs") -}} (line 98) w/:

   {{ $list := where site.RegularPages "Type" "in" site.Params.mainSections -}}

2. Add to ./config/_default/params.toml:

   # Search
   mainSections = ["blog", "docs"]

That's it:

[h-enk]

So that I understand what this code is meant to do (and perhaps have a better chance at troubleshooting the issue), does mainSections refer to the location of the content within the directory structure?

Yes, that's correct.

[alistaircom]

Ok thanks for that. I have installed a fresh starter theme, made changes to the two files, added a couple of blog entries, restarted the dev server and I cannot get anything from the blog entries to show in the search results.

New document pages that are added show up in the search results.

Rather than continue here, would you like me to create an issue for this?

[h-enk]

Please share your repo, so I can check what's missing

[alistaircom]

https://github.com/alistaircom/my-doks

[h-enk]

@alistaircom, thanks for sharing the repo link — it helped!

It turns out, it is a Hugo thing. This is how you make it work:

1. In ./assets/js/index.js, replace {{ $list := (where .Site.Pages "Section" "docs") -}} (line 98) w/:

   {{ $list := where site.RegularPages "Type" "in" site.Params.mainSections -}}

2. Add to ./config/_default/config.toml (so, not to ./config/_default/params.toml):

   # Search
   [params]
   mainSections = ['blog', 'docs']

And there you go:

[drwilkins]

This worked for me. But just FYI for those using the child theme, you'll need to create the folder assets/js/ in the root directory if it doesn't exist and copy the index.js file from node_modules/@hyas/assets/js/index.js to then make the modifications suggested above.

[roktas]

Hey @h-enk,

First of all thank you very much for the Doks theme, much appreciated.

Could this site.Params.mainSections thingy be a standard logic, to avoid patching assets/js/index.js and other files (the ones seen in #543, especially #543 (comment))? I'm hesitating to modify those files while using the child theme.

[h-enk]

Hey, nice to hear that you appreciate Doks!

The screenshot in this thread is from an older version of Doks. The latest version of Doks includes the search in the (docs) section navigation (see also Better UX navigation). So, now it wouldn't make sense anymore to combine two sections in the search.

Maybe it would be a something to have an option to have a site wide search, or a a docs search? I will be giving this some more thought.

[nk9]

As someone who is hoping to use the excellent base of Doks on a non-documentation site, with multiple different "post types", it makes more sense in my case to have a single, site-wide search. So I'd very much like to see this supported. I don't mind doing some extra setup to allow this non-standard use.

[h-enk]

Added #630

[johnnymatthews]

For folks doing this with the node_module thingy, here's the command you need to run to copy the correct file to the correct place:

mkdir -p assets/js && cp node_modules/@hyas/doks/assets/js/index.js assets/js

[StefanSalewski]

Configurable or system wide search would make a lot of sense for v1.0. My current configuration has no docs section at all, but sections books and faq, and a few more, all created with "npm run create -- --kind docs [section]". Well, I have a tiny blog currently, which I may remove later again. For the blog the search may work, but I have deactivated that search box now. For faq it would make sense when it would be working.

[h-enk]

Thanks! You've found a bug that will be is fixed in Doks 1.0.

The files in ./archetypes/docs/* should have their own type (just omit it). Meaning, your ./archetypes/docs/lorem/ipsum/index.md e.g. should look like:

---
title: "{{ replace .Name "-" " " | title }}"
description: ""
lead: ""
date: {{ .Date }}
lastmod: {{ .Date }}
draft: false
images: []
menu:
  {{ .Section }}:
    parent: "lorem"
    identifier: "{{ .Name }}-{{ delimit (shuffle (split (md5 .Name) "" )) "" }}"
weight: 100
toc: true
---

Which will render into:

---
title: "Ipsum"
description: ""
lead: ""
date: 2023-04-15T13:43:59+02:00
lastmod: 2023-04-15T13:43:59+02:00
draft: false
images: []
menu:
  guides:
    parent: "lorem"
    identifier: "ipsum-413b8467abfc839d649b59e84ebbd377"
weight: 100
toc: true
---

Now, you can set the sections (types) to include in search — in Doks 1.0 like so (in ./config/_default/hyas/doks.toml):

# FlexSearch
flexSearch = true # true (default) or false
indexPages = ["books", "faq"] # [] (all regular pages, default) or list of sections (e.g. ["blog", "guides"])
showSearch = [] # [] (all pages, default) or homepage (optionally) and list of sections (e.g. ["homepage", "blog", "guides"])

In Doks 0.5 like so (in ./config/_default/params.toml):

[..]
[options]
  [..]
  flexSearch = true
  searchSectionsShow = []
  searchSectionsIndex = ["books", "faq"]
[..]

Note that, now (in Doks 0.5) you'll have to copy ./layouts/docs/* and paste as ./layouts/books/* and ./layouts/faqs/*.

Doks 1.0 will use the ./_default/single.html and ./_default/list.html layouts — which will then be the layouts for the docs based types (like docs itself and e.g. books and faqs (so, no need to set layout in the frontmatter).