Live search shows matching docs as readers type, so they find answers without browsing. PinkDocs searches by meaning as well as keywords, so readers find the right doc even when they use different words from yours.
📷 Image placeholder: the live search box showing results as a reader types.
Where live search appears
- In the Hero section with search block on your docs homepage
- At the top of every doc page
- On category pages
How search finds results
PinkDocs searches your published doc titles, headings, content, excerpts and tags. It combines two methods:
| Method | What it matches | Example |
|---|---|---|
| Keyword search | The exact words a reader types | change slug finds docs containing slug |
| Meaning search | Docs about the same idea | rename my help page URL finds Changing the docs URL |
Add search to your homepage
Add the hero block
On your docs homepage, click +, search for PinkDocs and add Hero section with search.
Write the heading and placeholder
Enter a heading, such as How can we help?, and a placeholder that shows an example search, such as Search for install, licence or AI.
📷 Image placeholder: the Hero section with search block settings.
Turn on quick links (optional)
Turn on Show quick links to display popular searches under the search box.
Save
Click Save and test the search on your site.
Make docs easier to find
- Use the words readers use. Check your failed searches to learn them.
- Write clear titles that start with the task, such as Change the docs URL.
- Add an excerpt to every doc. Excerpts appear under each result.
- Use headings. Search can match a section inside a long doc.
- Add tags for synonyms and product names.
Common questions
Check that the doc is published. If you use a caching plugin, clear its cache.
Search covers the knowledge base the reader is in, so results stay relevant to the product they're reading about.