For 18 years, GSA’s Search.gov has transformed the public’s search experience on federal government websites. Agencies use our free, shared service to power over 2,000 search boxes on over 30% of federal domains. This page will walk you through the steps required to integrate Search.gov with your Federalist website.
On the Federalist side of things, part 1
- Confirm you have the
jekyll-sitemap gem installed in your repo. Read the docs here and instructions for GitHub Pages here.
On the Search.gov side of things:
- Sign up for a user account.
- Read our Search Site Launch Guide if you’d like some direction.
- Request that your domain be indexed by emailing our team. Note, the site must be publicly available for our indexer to be able to access your content.
- Create and configure a search site in our Admin Center. Note: you’ll give your site a display name and a site handle, and you’ll need to enter the site handle in the search box form code on your website.
- Preview your search results once the indexing is complete.
- Put finishing touches on your search site in the Admin Center - brand your results page, etc.
On the Federalist side of things, part 2
- Add your site handle from the Admin Center to the
_config.yml file in your Federalist repo, on the
- Include the
_includes/searchgov/form.html search box in your
- If you would like type-ahead search suggestions to appear in your website’s search box, add include the
_includes/searchgov/script.html block in your