Skip to content
EpoCanvas Docs
EpoCanvas Global Search
↑↓ Navigate ↵ Select ESC Close
EpoCanvas Global Search

Full-Text Search & Keyboard Shortcuts

Last updated: Sep 16, 2026 / EpoCanvas Official Architecture Specification

When working through large amounts of technical documentation, quickly finding the configuration option or parameter you need matters. EpoCanvas Docs has a built-in dual-mode search: the header search box locates text within the current page, while the Ctrl+K dialog searches all documentation across the site. Both modes run entirely in the browser, require no backend service, and work even when the site is hosted on an intranet without internet access.

Which Search Mode to Use When

ScenarioModeHow
You remember the text is in the current articleIn-page searchClick the search box in the header and type keywords
You are not sure which article has the content and need a site-wide searchSite-wide searchPress Ctrl + K (Cmd + K on Mac)

In-Page Search: the Header Search Box

Click the search box in the middle of the page header (magnifier icon) and type keywords directly:

Annotated view of in-page search in the header: (1) input box, (2) match counter, (3) previous/next navigation, (4) clear button, (5) highlights on the page

Figure: what the header search box looks like after typing “部署” (“deploy”). (1) Header input box; (2) match counter (e.g. 1/26); (3) previous / next navigation buttons; (4) clear button; (5) all matching text on the current page is highlighted automatically.

Enter Keywords

Supports English phrases (such as “deployment”, “components”), Chinese words, and code snippets (such as pnpm, astro.config.mjs). While you type, all matching text on the current page is immediately highlighted and the page scrolls to the first match.

Jump Between Matches

  • Press Enter or click the down arrow: jump to the next match;
  • Press Shift + Enter or click the up arrow: return to the previous match;
  • The search box shows a live N/M progress counter (e.g. 3/9), so you always know where you are.

Clear the Search and Restore the Page

Press Esc or click the × button to remove all highlights and restore the page.

Site-Wide Search: the Ctrl+K Dialog

No matter which page you are on, press Ctrl + K (Cmd + K on Mac), or click the Ctrl K badge on the right of the search box, and a global search window opens in the middle of the screen:

Annotated view of the site-wide search dialog: (1) trigger badge, (2) search input box, (3) results list, (4) keyboard shortcut bar

Figure: what the dialog looks like after typing “部署” (“deploy”). (1) The Ctrl K badge next to the search box (clicking it also opens the dialog); (2) search input box; (3) results grouped by document, with matching keywords highlighted; (4) keyboard shortcut hints at the bottom.

Enter Keywords

Supports English phrases (such as “deployment”, “components”), Chinese words, and code snippets (such as pnpm, astro.config.mjs). Results whose titles match are listed first.

Browse the Results List

Results are grouped by document. Each entry shows the document title, the section it belongs to, and a context preview containing the keywords, with matching words highlighted. Click a group title to expand or collapse the matching paragraphs for that document.

Complete the Whole Flow with the Keyboard

  • ↑ ↓: move the selection between results;
  • Enter: open the selected result and jump to the matching paragraph;
  • Esc: close the dialog.

No mouse required at any point.

Why Is the Search So Fast?

Comparison of the two search modes in EpoCanvas Docs: on the left, header in-page search (DOM traversal highlighting, live counting, and smooth scrolling); on the right, the Ctrl+K site-wide dialog (Pagefind WASM in-memory inverted index for fast matching)

Figure: how the two search modes work. Left: fast keyword location within the current page via the header. Right: site-wide search over a static index built on Pagefind WASM. Both run entirely in the browser.

Documentation search on many websites sends requests to a remote server’s database, and on a poor connection you just watch a spinner.

EpoCanvas Docs uses Pagefind, a local static search solution:

  1. Index extracted at build time: when you run pnpm run build, the system reads the content of every document and produces a set of compressed static index chunk files.
  2. Lightweight on-demand downloads: when you type in the search box, the browser fetches only the index chunks for the characters entered (each just a few KB to a few dozen KB).
  3. Instant local matching: matching and ranking happen entirely in the browser, so there is no network latency, and search works fully even on an intranet with no internet access.

Search Tips

  • Split into words: for more precise results, enter several words separated by spaces (for example Cloudflare domain).
  • Titles rank first: document titles and section headings carry the highest weight in ranking, so results with keyword hits in the title come first.
  • Dev mode limitation: the site-wide index is only generated at build time, and in the dev server started with pnpm run dev the Ctrl+K dialog does not load the index, so site-wide search is unavailable there. To try the search, run pnpm run build and then pnpm run preview to view the built site. In-page search is not affected.