Docs search with grouped, highlighted results

Default content

{
  "title": "Search the docs",
  "query": "preview env",
  "labels": {
    "search": "Search the docs",
    "placeholder": "Search guides, API and changelog",
    "all": "All results",
    "filter": "Filter by section",
    "summary": "{count} results for “{query}”",
    "emptyTitle": "No results for “{query}”",
    "emptyText": "Check the spelling, search for a CLI command like `rivet env set`, or try one of these instead.",
    "suggestions": "Popular searches",
    "clear": "Clear",
    "keys": {
      "navigate": "navigate",
      "open": "open",
      "clear": "clear",
      "up": "↑",
      "down": "↓",
      "enter": "↵",
      "escape": "esc"
    }
  },
  "suggestions": [
    "rivet env pull",
    "custom domains",
    "rollback",
    "build cache"
  ],
  "groups": [
    {
      "label": "Guides",
      "icon": "layers",
      "results": [
        {
          "title": "Preview environments",
          "href": "#",
          "path": [
            "Deploying"
          ],
          "excerpt": "Every branch and pull request gets its own preview environment with a stable URL. Previews read the preview scope of your environment variables."
        },
        {
          "title": "Environment variables",
          "href": "#",
          "path": [
            "Deploying"
          ],
          "excerpt": "Set a value for the preview scope with rivet env set KEY --env preview. Changes apply on the next deploy."
        },
        {
          "title": "Protect previews with a password",
          "href": "#",
          "path": [
            "Deploying",
            "Preview environments"
          ],
          "excerpt": "Set PREVIEW_PASSWORD in the preview env scope to put every preview behind basic auth. Production is never affected."
        },
        {
          "title": "Custom domains",
          "href": "#",
          "path": [
            "Deploying"
          ],
          "excerpt": "Point a CNAME at cname.rivetlane.app and add the domain with rivet domains add. Certificates renew automatically."
        },
        {
          "title": "Rollbacks",
          "href": "#",
          "path": [
            "Deploying"
          ],
          "excerpt": "Move production traffic back to any earlier ready deployment with rivet rollback. The build cache is reused, so it takes seconds."
        }
      ]
    },
    {
      "label": "API",
      "icon": "terminal",
      "results": [
        {
          "title": "Create a preview",
          "href": "#",
          "path": [
            "REST API",
            "Previews"
          ],
          "method": "POST",
          "excerpt": "POST /v1/previews builds a branch into a preview environment. Pass env to override preview-scoped variables for this preview only."
        },
        {
          "title": "List environment variables",
          "href": "#",
          "path": [
            "REST API",
            "Environment"
          ],
          "method": "GET",
          "excerpt": "GET /v1/projects/{id}/env returns every key with its scopes. Filter with ?scope=preview; secret values are never returned."
        },
        {
          "title": "Delete a deployment",
          "href": "#",
          "path": [
            "REST API",
            "Deployments"
          ],
          "method": "DELETE",
          "excerpt": "DELETE /v1/deployments/{id} removes a deployment that is not serving traffic. Production deployments must be rolled back first."
        }
      ]
    },
    {
      "label": "Changelog",
      "icon": "sparkles",
      "results": [
        {
          "title": "Preview environments boot in under 3 seconds",
          "href": "#",
          "path": [
            "Changelog"
          ],
          "meta": "v4.2 · Oct 7",
          "excerpt": "Previews resume from a snapshot of the last green build. Opt out with preview.snapshot = false in rivetlane.toml."
        },
        {
          "title": "Per-preview environment overrides",
          "href": "#",
          "path": [
            "Changelog"
          ],
          "meta": "v4.1 · Sep 16",
          "excerpt": "Override a preview env variable for a single pull request from the dashboard or with rivet env set --preview 482."
        },
        {
          "title": "Build cache keys include the lockfile hash",
          "href": "#",
          "path": [
            "Changelog"
          ],
          "meta": "v4.0 · Aug 26",
          "excerpt": "Changing pnpm-lock.yaml now invalidates the build cache. Pass --force to rivet deploy to skip the cache entirely."
        }
      ]
    }
  ]
}