mkdocs.yml

site_name: SparkFun Qwiic TMF882X Arduino Library - Hookup Guide
site_description: SparkFun Arduino Library for Qwiic TMF882X Boards
site_url: https://sparkfun.github.io/SparkFun_Qwiic_TMF882X_Arduino_Library


theme:
  name: material
  logo: img/sfe_logo_sm.png
  palette:
    primary: grey
    accent: red
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.annotate
    - navigation.tracking
    - navigation.tabs.sticky
    - navigation.tabs

  icon:
    repo: fontawesome/brands/github
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: octicons/squirrel-16
      success: octicons/check-16
      question: octicons/question-16
      warning: octicons/alert-16
      failure: octicons/x-circle-16
      danger: octicons/zap-16
      bug: octicons/bug-16
      example: octicons/beaker-16
      quote: octicons/quote-16

plugins:
  - search
  - monorepo

repo_url: https://github.com/sparkfun/SparkFun_Qwiic_TMF882X_Arduino_Library
repo_name: sparkfun/SparkFun_Qwiic_TMF882X_Arduino_Library

copyright: Copyright 2022 SparkFun Electronics (6333 Dry Creek Parkway, Niwot, Colorado 80503)

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.mark
  - pymdownx.caret
  - pymdownx.tilde
  - tables
  - admonition

extra:
  social:
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/sparkfun
    - icon: fontawesome/brands/instagram
      link: https://www.instagram.com/sparkfun
    - icon: fontawesome/brands/github
      link: https://www.github.com/sparkfun
    - icon: fontawesome/brands/facebook
      link: https://www.facebook.com/SparkFun
    - icon: fontawesome/brands/x-twitter
      link: https://twitter.com/sparkfun
    - icon: fontawesome/solid/cookie-bite
      link: ./#__consent
      name: Change cookie settings

  # Configures Google Analytics
  analytics:
    provider: google
    property: G-7Y7EYCZVC1

  consent:
    cookies:
      analytics:
        name: Google Analytics
        checked: true
    title: Cookie consent
    description:
      We use cookies to recognize your repeated visits and preferences, as well as to measure the effectiveness of our documentation and whether users find what they're searching for. With your consent, you're helping us to make our documentation better.
    actions:
      - accept
      - manage
      - reject

nav:
  - Home: index.md
  - Getting Started:
    - Software Setup: software.md
  - API Reference:
    - Device: api_device.md
    - Setup: api_setup.md
    - Operation: api_operation.md