快轉到主要內容

Search

查看原始碼編輯此頁 (外部連結)
首次發表:

search.css (外部連結) build.sh (外部連結)

Built-in search is powered by Pagefind (外部連結), a static search library that serves results entirely in the browser with no external service needed.

Enabling search requires two steps: setting a config flag so Yore renders the search UI, and running Pagefind after every build to generate the search index. Both are required because the UI will not work without the index.

Step 1: Enable the search UI 此標題的連結

hugo.yaml
params:
  searchEnabled: true

Step 2: Generate the search index 此標題的連結

Pagefind reads the HTML files Hugo produces and builds a search index from them. Install Node.js (外部連結), then add Pagefind to your development dependencies:

npm install -D pagefind

Add the following scripts to package.json.

package.json
{
  "scripts": {
    "pagefind": "pagefind --site public",
    "build": "hugo --gc --minify && npm run pagefind",
    "dev": "hugo server"
  }
}

Finally, run npm run pagefind after the site is built.

重要

Include the indexing step in your deployment script (GitHub workflow, Cloudflare build script, etc.), otherwise search will not appear on the deployed site.

Set pageNoList: true in a page's front matter to exclude it from search results and list pages.

文章關聯

無障礙設定