Quickstart: paste a URL
Point the crawler at your site, verify your domain and go live without touching your build.
This is the fastest way in for a docs site or marketing site a crawler can read: no build step, no code to write until the widget goes in.
1. Paste your URL
Sign in to your dashboard and paste your site's URL, for example docs.example.com. suo looks for a sitemap first.
Found 312 pages via sitemap.xml
If there is no sitemap, suo follows links from the page you gave it. Either way, you can adjust which paths are included or excluded before the crawl starts.
2. Verify your domain
Prove you own the domain with a DNS TXT record or a meta tag (see Verify your domain) — this stops anyone else from pointing our crawler at your site under your account.
3. Watch it crawl
The dashboard shows a live page counter, never a fake progress bar, and each URL's state: indexed, skipped (with a reason), failed (with a reason) or queued.
Once about 10 pages are indexed, the playground runs a sample query against your real content so you can see results before the crawl finishes.
4. Add the widget
Copy the install snippet — your search key is already filled in — and paste it into your site. Tabs are given for plain HTML, React, Next and fumadocs; see Install for the full reference.
<script src="https://cdn.usesuo.com/widget@1.js" async></script>
<suo-search host="https://api.usesuo.com" api-key="suo_search_YOUR_KEY" index-name="docs"></suo-search>The dashboard flips to "Your search is live" the moment the first query arrives from your verified domain.
Keeping it fresh
A crawl runs again on a schedule you set, or on demand from the dashboard or suo crawl. Only pages whose content changed are re-indexed.
Next: read Crawl a docs site for include and exclude rules, or Concepts to see how a crawled page becomes searchable records.