_pkgdown.yml

url: https://cfbplotR.sportsdataverse.org/

template:
  bootstrap: 5
  light-switch: true
  bootswatch: cosmo
  includes:
    in_header: |
      <script defer data-domain="cfbplotr.sportsdataverse.org" src="https://plausible.io/js/plausible.js"></script>
  bslib:
    primary: "#222222"
    secondary: "#222222"
    success: "#2680E4"
    link-color: "#2680E4"
    link-hover-color: "#2680E4"
    nav-link-hover-color: "#2680E4"
    nav-link-focus-color: "#2680E4"
    nav-link-dropdown-toggle-hover-color: "#2680E4"
    navbar-hover-color: "#2680E4"
    navbar-brand-hover-color: "#2680E4"
    nav-tabs-link-active-bg	: "#2680E4"
    nav-pills-link-active-color: "#2680E4"
    btn-link-color: "#2680E4"
    btn-link-hover-color: "#2680E4"
    dropdown-link-color: "#2680E4"
    input-btn-focus-color: "#2680E4"
    dropdown-dark-link-hover-bg: "#2680E4"
    border-radius: 0.5rem
    btn-border-radius: 0.25rem
  opengraph:
    image:
      src: "https://raw.githubusercontent.com/sportsdataverse/cfbplotR/main/man/figures/logo.png"
      alt: "cfbplotR social preview card"
    twitter:
      creator: "@JaredDLee"
      site: "@cfbfastR"
      card: summary


authors:
  Sebastian Carl:
    href: https://x.com/mrcaseb
  Jared Lee:
    href: https://x.com/JaredDLee
  Saiem Gilani:
    href: https://x.com/saiemgilani

reference:
  - title: "Logos, Wordmarks & Headshots"
    desc: >
      ggplot2 geoms and ggproto objects for rendering CFB team logos,
      wordmarks, and player headshots on plots.
    contents:
      - geom_cfb_logos
      - GeomCFBlogo
      - geom_cfb_headshots
      - geom_cfb_wordmarks
      - GeomCFBheads
  - title: "Theme Elements"
    desc: >
      Image-based ggplot2 theme elements for axis text — replace tick labels
      with CFB logos, wordmarks, or headshots.
    contents:
      - element
  - title: "Scales & Axes"
    desc: >
      CFB color/fill scales and logo/headshot axis annotation scales.
    contents:
      - scale_color_cfb
      - scale_axes_cfb
      - theme_cfb
  - title: "gt Table Helpers"
    desc: >
      Embed CFB team logos, wordmarks, and player headshots inside gt table
      cells or column labels.
    contents:
      - gt_cfb
      - gt_cfb_cols_label
      - gt_stack_team
  - title: "Team Utilities"
    desc: >
      Validate, clean, and factor-order CFB team names and abbreviations;
      look up athlete IDs; control the image cache.
    contents:
      - valid_team_names
      - clean_school_names
      - clean_team_abbrs
      - cfb_team_factor
      - add_athlete_id_col
      - ".cfbplotR_clear_cache"
  - title: "Premade Plots"
    desc: >
      High-level functions that build complete CFB-branded plots.
    contents:
      - cfb_team_tiers
  - title: "Plot Titles & Preview"
    desc: >
      Add images to ggplot2 titles and preview plots at exact output dimensions.
    contents:
      - ggtitle_image
      - ggpreview
  - title: "Package Data"
    desc: >
      Built-in reference datasets shipped with cfbplotR.
    contents:
      - data
  - title: "Re-exported from ggpath"
    desc: Generic image geoms and theme elements provided by the ggpath backend.
    contents:
      - reexports


navbar:
  structure:
    left: [home, reference, articles, news, games, network, data]
    right: [search, twitter, github, lightswitch]
  components:
    home:
      title: cfbplotR • Plot CFB Team Logos
      description: >
        A set of functions to visualize College Football
        analysis in 'ggplot2'.
      icon: fa-home
      href: index.html
      aria-label: Home
    reference:
      icon: "fas fa-code"
      text: "Funcs"
      href: reference/index.html
      menu:
      - text: "Function Index"
        href: reference/index.html
      - text: --------------------------------
      - text: "Plots"
      - text: "Plot Logos"
        href: reference/geom_cfb_logos.html
      - text: "Plot Headshots"
        href: reference/geom_cfb_headshots.html
      - text: "ggpath Re-exports"
        href: reference/reexports.html
      - text: "Team Colors"
        href: reference/scale_color_cfb.html
      - text: "Title Image"
        href: reference/ggtitle_image.html
      - text: "Axis Logos"
        href: reference/scale_axes_cfb.html
      - text: "Axis Image Elements"
        href: reference/element.html
      - text: --------------------------------
      - text: "Premade Plots"
      - text: "Team Tiers"
        href: reference/cfb_team_tiers.html
      - text: --------------------------------
      - text: "Tables"
      - text: "Add Logos/Headshots"
        href: reference/gt_cfb.html
      - text: "Merge Columns with Team Color"
        href: reference/gt_stack_team.html
      - text: --------------------------------
      - text: "Utilties"
      - text: "Valid Names"
        href: reference/valid_team_names.html
      - text: "Clean Names"
        href: reference/clean_school_names.html
      - text: "Athlete IDs"
        href: reference/add_athlete_id_col.html
    articles:
      icon: "fas fa-book-reader"
      text: " Articles"
      href: articles/index.html
    news:
      icon: "fas fa-newspaper"
      text: " Changelog"
      href: news/index.html
    games:
      icon: "fas fa-football-ball"
      text: " GP"
      href: http://gameonpaper.com/cfb
    network:
      icon: "fas fa-project-diagram"
      text: " SDV"
      menu:
      - text: SportsDataverse
        href: https://sportsdataverse.org/
      - text: --------------------------------
      - text: "R Packages"
      - text: sportsdataverse-R
        href: https://r.sportsdataverse.org/
      - text: cfbfastR
        href: https://cfbfastR.sportsdataverse.org/
      - text: hoopR
        href: https://hoopR.sportsdataverse.org/
      - text: wehoop
        href: https://wehoop.sportsdataverse.org/
      - text: fastRhockey
        href: https://fastRhockey.sportsdataverse.org/
      - text: ggshakeR
        href: https://abhiamishra.github.io/ggshakeR/
      - text: baseballr
        href: https://BillPetti.github.io/baseballr/
      - text: usfootballR
        href: https://usfootballR.sportsdataverse.org/
      - text: soccerAnimate
        href: https://github.com/Dato-Futbol/soccerAnimate/
      - text: chessR
        href: https://jaseziv.github.io/chessR/
      - text: oddsapiR
        href: https://oddsapiR.sportsdataverse.org/
      - text: sportyR
        href: https://sportyR.sportsdataverse.org/
      - text: cfbplotR
        href: https://cfbplotR.sportsdataverse.org/
      - text: mlbplotR
        href: https://camdenk.github.io/mlbplotR/
      - text: softballR
        href: https://github.com/sportsdataverse/softballR/
      - text: cfb4th
        href: https://cfb4th.sportsdataverse.org/
      - text: nwslR
        href: https://github.com/nwslR/nwslR/
      - text: recruitR
        href: https://recruitR.sportsdataverse.org/
      - text: puntr
        href: https://puntalytics.github.io/puntr/
      - text: --------------------------------
      - text: "Python Packages"
      - text: sportsdataverse-py
        href: https://py.sportsdataverse.org/
      - text: sportypy
        href: https://sportypy.sportsdataverse.org/
      - text: nwslpy
        href: https://github.com/nwslR/nwslpy/
      - text: collegebaseball
        href: https://github.com/nathanblumenfeld/collegebaseball/
      - text: --------------------------------
      - text: "Node.js Packages"
      - text: sportsdataverse.js
        href: https://js.sportsdataverse.org/
      - text: nfl-nerd
        href: https://github.com/nntrn/nfl-nerd/
    data:
      icon: "fas fa-database"
      text: " Data"
      menu:
      - text: "CFBData.com"
        href: https://collegefootballdata.com
      - text: "Data Repository"
        href: https://github.com/sportsdataverse/cfbfastR-data
      - text: "Raw Data Repository"
        href: https://github.com/sportsdataverse/cfbfastR-raw
    twitter:
      icon: "fab fa-x-twitter fa-lg"
      href: https://x.com/cfbfastR
      aria-label: X (Twitter)
    github:
      icon: "fab fa-github fa-lg"
      href: https://github.com/sportsdataverse/cfbplotR/
      aria-label: GitHub