Scraps Doc

Explanation/

Search Architecture

commited date: 2025-11-17

#Static Site

Search index format

Scraps can build a search index using the Fuse JSON schema as shown below.

[
    {
      "title": "Search",
      "url": "http://127.0.0.1:1112/scraps/search.html"
    },
    {
      "title": "Overview",
      "url": "http://127.0.0.1:1112/scraps/overview.html"
    },
    ...
]

Search libraries

Scraps content perform searches with fuse.js using an index.

We are considering WASM solutions like tinysearch for future performance improvements in our deployment environment.

Configuration

If you are not using the search function, please modify your Config.toml as follows. See the Configuration page for details.

# Build a search index with the Fuse JSON and display search UI (optional, default=true, choices=true or false)
build_search_index = false