mkdocs.yml

# Documentation page information
site_name: SparkFun RTK Torch Hookup Guide
site_description: The product manual for the RTK Torch GNSS receiver from SparkFun Electronics
site_url: https://sparkfun.github.io/SparkFun_RTK_Torch
site_author: SparkFun Electronics

repo_url: https://github.com/sparkfun/SparkFun_RTK_Torch
repo_name: sparkfun/SparkFun_RTK_Torch
edit_uri: edit/main/docs/

theme:
  name: material
  custom_dir: docs/overrides
  logo: img/Icons/sfe_logo_sm.png
  palette:
    primary: grey
    accent: red
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - content.code.annotate

    # Enable "view source" and "edit this page" buttons
    - content.action.edit

    # Enables anchor tracking (updates page url with the section user is on)
    # i.e. https://docs.sparkfun.com/<page link>/#<sub-section>
    - navigation.tracking
    - navigation.tabs.sticky
      
    # Enables tabs for navigating the website
    # - navigation.tabs
    # Keeps tabs visible in the header when scrolling
    #- navigation.tabs.sticky
    
    # Adds pop-up button just below the header (when the user starts to scroll up)
    # Allows users to easily jump to the beginning of the page
    - navigation.top

    # Renders path for page navigation at top of the page (makes page navigation more mobile friendly)
    - navigation.path


  # Icon in Browser Tab (must be square img - i.e. 32x32 pixels)
  favicon: img/Icons/sfe_logo_sq.png
  
  icon:
    repo: fontawesome/brands/github

    # Sets icon for "edit this page" buttons
    edit: material/file-document-edit-outline
    
    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

  #Generates PDF
  - with-pdf:
      copyright: SparkFun Electronics - 2024
      cover_subtitle: Simple and Cost Effective High-Precision Navigation
      output_path: pdf/SparkFun_RTK_Torch.pdf
      author: This PDF is automatically generated. See https://docs.sparkfun.com/SparkFun_RTK_Torch/ for the latest version.
      toc_title: Table Of Contents
      #cover_title: TITLE TEXT
      #heading_shift: false
      #toc_level: 3
      #ordered_chapter_level: 2
      #exclude_pages:
      #    - 'bugs/'
      #    - 'appendix/contribute/'
      #convert_iframe:
      #    - src: IFRAME SRC
      #      img: POSTER IMAGE URL
      #      text: ALTERNATE TEXT
      #    - src: ...
      #two_columns_level: 3
      #debug_html: true
      #show_anchors: true
      #verbose: true

copyright: 
    Copyright 2024 - <a href="https://www.sparkfun.com/" target="_blank" rel="noopener">SparkFun Electronics&#174;<br>
    <a href="https://goo.gl/maps/vkstCpQZW6jZMjzYA" target="_blank" rel="noopener">6333 Dry Creek Parkway, Niwot, Colorado 80503</a>

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/twitter
      link: https://twitter.com/sparkfun

# Configures webpage navigation
nav:
  - Hardware Overview: hardware_overview.md
  - Hardware Assembly: hardware_assembly.md
  - Firmware Overview: firmware_overview.md
  - Operating Modes: operating_modes.md
  - Reference Documents: reference_documents.md
  - Submit Issues: file_issue.md
  - Contribute: contribute.md