_config.yml

# Welcome to Jekyll!
#
# This config file is meant for settings that affect your whole blog, values
# which you are expected to set up once and rarely edit after that. If you find
# yourself editing this file very often, consider using Jekyll's data files
# feature for the data you need to update frequently.
#
# For technical reasons, this file is *NOT* reloaded automatically when you use
# 'bundle exec jekyll serve'. If you change this file, please restart the server process.

# Site settings
# These are used to personalize your new site. If you look in the HTML files,
# you will see them accessed via {{ site.title }}, {{ site.email }}, and so on.
# You can create any custom variable you would like, and they will be accessible
# in the templates via {{ site.myvariable }}.

##########################################################################################
# Be sure to edit the values below
##########################################################################################

title: Search.gov
email: search@gsa.gov
# description: >- # this means to ignore newlines until "baseurl:"
baseurl: "" # the subpath of your site, e.g. /blog
url: "https://search.gov" # the base hostname & protocol for your site, e.g. http://example.com

# Twitter handle. Only the handle, not the URL.
# twitter: 

#################################################################
#
# Digital Analytics Program (DAP) configuration
#
# USAID   - Agency for International Development
# USDA    - Department of Agriculture
# DOC     - Department of Commerce
# DOD     - Department of Defense
# ED      - Department of Education
# DOE     - Department of Energy
# HHS     - Department of Health and Human Services
# DHS     - Department of Homeland Security
# HUD     - Department of Housing and Urban Development
# DOJ     - Department of Justice
# DOL     - Department of Labor
# DOS     - Department of State
# DOI     - Department of the Interior
# TREAS   - Department of the Treasury
# DOT     - Department of Transportation
# VA      - Department of Veterans Affairs
# EPA     - Environmental Protection Agency
# EOP     - Executive Office of the President
# GSA     - General Services Administration
# NASA    - National Aeronautics and Space Administration
# NARA    - National Archives and Records Administration
# NSF     - National Science Foundation
# NRC     - Nuclear Regulatory Commission
# OPM     - Office of Personnel Management
# USPS    - Postal Service
# SBA     - Small Business Administration
# SSA     - Social Security Administration
#
#################################################################
dap:
  agency: GSA

# Optional
  subagency: TTS

# Configuration for Google Analytics
# ga:
#   ua: UA-31302465-1

# Site Navigation
primary_navigation:
  - name: About Us
    children:
      - name: About Us
        url: "/about/"
      - name: Why Choose Search.gov?
        url: "/about/why-choose-searchgov.html"
      - name: Customers
        url: "/about/customers.html"
      - name: Search.gov in Policy
        url: "/about/policy/"
      - name: Year in Review
        url: "/about/updates/year-in-review/"
      - name: Security and Compliance
        url: "/about/security.html"
      - name: Our Product Roadmap
        url: "/about/updates/roadmap/"
      - name: Release Notes
        url: "/about/updates/releases/"
      - name: Newsletters
        url: "/about/updates/newsletters/"
      - name: Share Your Feedback
        url: "/about/feedback.html"
      - name: For Developers
        url: "/developer/"
  - name: Get Started
    children:
      - name: Get Started With Search.gov
        url: "/get-started/"
      - name: Sign Up/Create an Account
        url: "/get-started/account.html"
      - name: Site Launch Guide
        url: "/get-started/site-launch-guide.html"
      - name: "Going live with Search.gov: Checklist"
        url: "/get-started/go-live.html"
      - name: Results Page Feature Comparison
        url: "/admin-center/display/hosted-vs-api-results.html"
      - name: Cloud.gov Pages Integration
        url: "/get-started/searchgov-for-cloudgov-pages.html"
      - name: Training and Resources
        url: "/get-started/learn.html"
      - name: Website Redesign Tips
        url: "/indexing/redesign.html"
  - name: Manage Your Search Site
    children:
      - name: Full Help Manual
        url: "/admin-center/index.html"
      - name: Add or Remove Users
        url: "/admin-center/dashboard/users.html"
      - name: Add a Site
        url: "/admin-center/dashboard/add-site.html"
      - name: Add Domains
        url: "/admin-center/content/domains.html"
      - name: Manage Your Search Analytics
        url: "/admin-center/analytics/index.html"
      - name: Add Search Features
        url: "/get-started/site-launch-guide.html#add-features"
      - name: Website Redesign Tips
        url: "/indexing/redesign.html"
  - name: Index With Search.gov
    children:
      - name: Start Here
        url: "/indexing/indexing-with-searchgov.html"
      - name: What We Index
        url: "/indexing/what-searchgov-indexes.html"
      - name: Relevance Ranking
        url: "/indexing/ranking-factors.html"
      - name: How a Page Becomes a Search Result
        url: "/indexing/sitemaps-to-search-sites.html"
      - name: Indexing Step-By-Step
        url: "/indexing/indexing-workflow.html"
      - name: Metadata and Tags
        url: "/indexing/metadata.html"
      - name: "PDF Metadata"
        url: "/indexing/pdf-metadata.html"
      - name: Website Redesign Tips
        url: "/indexing/redesign.html"
  - name: Support
    url: "/support.html"
  - name: For Developers
    url: "/developer/"
# END Site Navigation

# Sidebar configuration
#
# A sidebar of up to 3 levels can be configured here
# and included in the page by adding a `sidenav` property
# to the front matter that corresponds to the key defined here.
# Example:
# Adding the property `sidenav: admin_center` to a page will
# import the `admin_center` navigation defined below. If no
# `sidenav` property is specified, no sidebar will appear on the page

about_us:
  - name: About Us
    url: /about/
    children: 
    - name: Why Choose Search.gov?
      url: "/about/why-choose-searchgov.html"
    - name: Customers
      url: "/about/customers.html"
    - name: Search.gov in Policy
      url: "/about/policy/"
    - name: Year in Review
      url: "/about/updates/year-in-review/"
    - name: Security and Compliance
      url: "/about/security.html"
    - name: Our Product Roadmap
      url: "/about/updates/roadmap/"
    - name: Release Notes
      url: "/about/updates/releases/"
    - name: Newsletters
      url: "/about/updates/newsletters/"
    - name: Share Your Feedback
      url: "/about/feedback.html"
  - name: Related Resources
    children: 
    - name: For Developers
      url: "/developer/"

admin_center:
  - name: Admin Center Help Manual
    url: "/admin-center/"
    children: 
      - name: Dashboard
        url: "/admin-center/dashboard/"
      - name: Analytics
        url: "/admin-center/analytics/"
      - name: Content
        url: "/admin-center/content/"
      - name: Display
        url: "/admin-center/display/"
      - name: Preview
        url: "/admin-center/preview.html"
      - name: Activate
        url: "/admin-center/activate/"
  - name: Additional Resources
    url: "/admin-center/#additional-resources"
    children:
      - name: Website Redesign Tips
        url: "/indexing/redesign.html"


get_started:
  - name: Get Started With Search.gov
    url: "/get-started/"
    children:
      - name: Sign Up
        url: "/get-started/account.html"
      - name: Site Launch Guide
        url: "/get-started/site-launch-guide.html"
      - name: Search.gov for Cloud.gov Pages
        url: "/get-started/searchgov-for-cloudgov-pages.html"
      - name: "Going live with Search.gov: Checklist"
        url: "/get-started/go-live.html"
      - name: Training and Resources
        url: "/get-started/learn.html"
        children:
          - name: Training Webinars
            url: "/get-started/training.html"
  - name: Related Resources
    children:
      - name: Why Choose Search.gov?
        url: "/about/why-choose-searchgov.html"
      - name: Results Page Feature Comparison
        url: "/admin-center/display/hosted-vs-api-results.html"
      - name: Website Redesign Tips
        url: "/indexing/redesign.html"
    

indexing:
  - name: Index With Search.gov
    url: "/indexing/indexing-with-searchgov.html"
    children:
      - name: How Does Indexing Work?
        children:
          - name: What Search.gov Indexes From Your Website
            url: "/indexing/what-searchgov-indexes.html"
          - name: How Search.gov Ranks Your Search Results
            url: "/indexing/ranking-factors.html"
          - name: How a Page on a Sitemap Becomes a Search Result
            url: "/indexing/sitemaps-to-search-sites.html"
          - name: A Step-By-Step Indexing Workflow
            url: "/indexing/indexing-workflow.html"
          - name: How Search Engines Index Your Website (Webinar)
            url: "/get-started/training.html#how-engines-index"
      - name: Domain Level SEO Supports
        children:
          - name: All About XML Sitemaps
            url: "/indexing/sitemaps.html"
          - name: "/robots.txt Files"
            url: "/indexing/robotstxt.html"
      - name: Page Level SEO Supports
        children:
          - name: Metadata and Tags You Should Include in Your Website
            url: "/indexing/metadata.html"
          - name: How to improve PDF discoverability
            url: "/indexing/pdf-metadata.html"
          - name: How to Get Search Engines to Index the Right Content for Better Discoverability
            url: "/indexing/how-search-engines-index-content-better-discoverability.html"
  - name: Website Redesign Tips
    url: "/indexing/redesign.html"

support:
  - name: Support
    url: "/support.html"
  - name: System Status
    url: "/status.html"
  - name: Training and Resources
    url: "/get-started/learn.html"
    children:
      - name: Training Webinars
        url: "/get-started/training.html"
  - name: Website Redesign Tips
    url: "/indexing/redesign.html"
  - name: Share Your Feedback
    url: "/about/feedback.html"
  - name: For Developers
    url: "/developer/"

# END sidebar configuration

# Homepage highlights section
highlights:
  - heading: Highly configurable
    copy: No developers required - use our easy interface to design your search experience yourself, including what content to search, recommended content, and the look and feel of your search results page.
  - heading: Built for government
    copy: Because we only engage with government clients, we orient ourselves around your needs, whether it is security, compliance, search results coverage, or the unique circumstances of government web publishing.
  - heading: Hands-on customer service
    copy: Our team of experts is available to help you with your questions, ranging from technical support and troubleshooting to search engine optimization consultations. Your success is our mission.
  - heading: No barriers to entry
    copy: Adopting a new tool or service is often difficult for federal agencies, but getting started with Search.gov is friction free. Our service is ready to use, and does not require interagency agreements, payments, or other common procedural challenges.

# Homepage How Do I? section
tasks:
  - heading: Get help to log in
    copy: If you’re unable to log in to your account, email us for help.
    url: mailto:search@gsa.gov
    cta: Email Us
  - heading: Re-index your site or submit sitemap 
    copy: Let us know if your search results are outdated, or if you have a new sitemap.
    url: mailto:search@gsa.gov
    cta: Email Us
  - heading: Learn about Results API features
    copy: We offer a robust API for pulling search results, but its feature set is different from our hosted results page.
    url: /admin-center/display/hosted-vs-api-results.html
    cta: Compare Features
  - heading: Add or remove users
    copy: You can manage who has access to your search site in the Admin Center.
    url: /admin-center/dashboard/users.html
    cta: Manage Users


# Search.gov configuration
#
# 1. Create an account with Search.gov https://search.usa.gov/signup
# 2. Add a new site.
# 3. Add your site/affiliate name here.
searchgov:

  # You should not change this.
  endpoint: https://find.search.gov

  # replace this with your search.gov account
  affiliate: usasearch

  # replace with your access key
  access_key: Q_XTNBtjvH-l0g1JU5QVj9G6vJRFnYkoR2NMSZKFWBc=

  # this renders the results within the page instead of sending to user to search.gov
  inline: false
  
  # this allows Search.gov to present relevant type-ahead search suggestions in your website's search box.
  suggestions: true

##########################################################################################
# The values below here are more advanced and should only be
# changed if you know what they do
##########################################################################################

collections:
  about:
    output: true
    permalink: /about/:path:output_ext
  admin-center:
    output: true
    permalink: /admin-center/:path:output_ext
  developer:
    output: true
    permalink: /developer/:path:output_ext
  get-started:
    output: true
    permalink: /get-started/:path:output_ext
  indexing:
    output: true
    permalink: /indexing/:path:output_ext
  pages:
    output: true
    permalink: /:path/
  releases:
    output: true
    permalink: /about/updates/releases/:title:output_ext
  newsletters:
    output: true
    permalink: /about/updates/newsletters/:title:output_ext


permalink: /:categories/:title:output_ext

############################################################
# Plugin config
############################################################
paginate_per_page: 10
posts_paginate_path: blog/page:num
posts_paginate_layout: paginate
posts_tag_layout: tag

############################################################
# Site configuration for the Jekyll 3 Pagination Gem
# The values here represent the defaults if nothing is set
pagination:
  # Site-wide kill switch, disabled here it doesn't run at all
  enabled: true
  # Set to 'true' to enable pagination debugging. This can be enabled in the site config or only for individual pagination pages
  debug: false
  # The default document collection to paginate if nothing is specified ('posts' is default)
  collection: "posts"
  # How many objects per paginated page, used to be `paginate` (default: 0, means all)
  per_page: 3
  # The permalink structure for the paginated pages (this can be any level deep)
  permalink: "/page/:num/" # Pages are index.html inside this folder (default)
  #permalink: '/page/:num.html' # Pages are simple html files
  #permalink: '/page/:num' # Pages are html files, linked jekyll extensionless permalink style.
  # Optional the title format for the paginated pages (supports :title for original page title, :num for pagination page number, :max for total number of pages)
  title: ":title - page :num"
  # Limit how many pagenated pages to create (default: 0, means all)
  limit: 0
  # Optional, defines the field that the posts should be sorted on (omit to default to 'date')
  sort_field: "date"
  # Optional, sorts the posts in reverse order (omit to default decending or sort_reverse: true)
  sort_reverse: true
  # Optional, the default category to use, omit or just leave this as 'posts' to get a backwards-compatible behavior (all posts)
  category: "posts"
  # Optional, the default tag to use, omit to disable
  tag: ""
  # Optional, the default locale to use, omit to disable (depends on a field 'locale' to be specified in the posts,
  # in reality this can be any value, suggested are the Microsoft locale-codes (e.g. en_US, en_GB) or simply the ISO-639 language code )
  locale: ""
  # Optional,omit or set both before and after to zero to disable.
  # Controls how the pagination trail for the paginated pages look like.
  trail:
    before: 2
    after: 2
  # Optional, the default file extension for generated pages (e.g html, json, xml).
  # Internally this is set to html by default
  extension: html
  # Optional, the default name of the index file for generated pages (e.g. 'index.html')
  # Without file extension
  indexpage: "index.html"

exclude:
  - package.json
  - package-lock.json
  - README.md
  - CONTRIBUTING.md
  - LICENSE.md
  - degit.json
  - vendor
  - node_modules
  - Gemfile
  - Gemfile.lock

autoprefixer:
  browsers:
    - "> 2%"
    - "last 2 versions"
    - "IE 11"
    - "not dead"

sass:
  source_dir: _sass
  load_paths:
    - node_modules/uswds/dist/
  sourcemap: development
  quiet_deps: true
  style: compressed
  verbose: true

timezone: America/New_York