Documentation Search in Sanity

README.md

Documentation Search in Sanity

This Gist contains a sample query for searching text content in GROQ, Sanity's custom query language. We use something similar to this for Causal's documentation site. See more on our blog!

query.groq

*[_type == "docPage"]
| score(
    boost(title match $queryString, 7),
    boost(description match $queryString, 1),
    boost(pt::text(content) match $queryString, 0.5)
  )
{
  _score,
  title,
  content,
  ...
}[ _score > 0 ]
| order(_score desc)[0...$limit]

queryString.ts

// This is the code we use to convert a user's raw text query to the `queryString` we pass
// to the GROQ query above

// For example, "category  agg" would be converted to "*category* *agg*"

const queryString = query
  .trim()
  .replaceAll(/\s+/g, " ") // replace multiple spaces with a single space
  .split(" ")
  .map(s => `*${s}*`) // allow partial matches (e.g. "agg" can match "aggregation")
  .join(" ");