GoMark GoMark GoMark

Search

Understand the built-in search endpoint and how GoMark indexes markdown content.

Search ships ready to use. GoMark builds an index from your content and exposes it over HTTP — no external service, no setup, just a query away.

Endpoint#

GET /api/search

Query parameters#

  • q: search query
  • limit: optional result limit, default 8, capped at 25

Example request#

terminal
curl "http://localhost:8080/api/search?q=render&limit=5"

Example response#

response.json
{
  "query": "render",
  "results": [
    {
      "title": "Configuration",
      "path": "/guides/configuration",
      "snippet": "...Configure GoMark with Site options, environment-driven behavior, and feature toggles..."
    }
  ]
}

Notes#

  • Empty queries return an empty result set
  • The index is built from your markdown content
  • In PreRender mode, the index is built once at startup