mkdocs.yml

# Documentation page information
site_name: Hookup Guide - SparkFun IoT Brushless Motor Driver
site_description: A hookup guide for the IoT BLDC Motor Driver
site_url: https://sparkfun.github.io/SparkFun_IoT_Brushless_Motor_Driver
site_author: SparkFun Electronics

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

copyright:
  Copyright 2023 - <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>

# Default edit/view actions to "main" branch, instead of "master"
edit_uri: blob/main/docs/



# Configuration for webpage theme
theme:
  # Theme: https://squidfunk.github.io/mkdocs-material/
  name: material


  # Icon in Browser Tab (must be square img - i.e. 32x32 pixels)
  favicon: img/sfe_logo_sq.png


  # Page Font
  font:
    text: Roboto
    code: Roboto Mono
  

  # Features to Include (ref. theme documentation)
  features:
    # Enable copy button on code blocks
    - content.code.copy

    # Enable annotations in code blocks
    - content.code.annotate

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

    # Enable Navigation buttons in the footer (i.e. previous/next)
    - navigation.footer

    # Enables anchor tracking (updates page url with the section user is on)
    # i.e. https://docs.sparkfun.com/<page link>/#<sub-section>
    - navigation.tracking

    # 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


  # Adds light/dark theme to the webpage
  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      primary: grey
      accent: red
      toggle:
        icon: material/brightness-auto
        name: Switch to dark mode

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      primary: grey
      accent: red
      scheme: default 
      toggle:
        icon: material/brightness-7
        name: Switch to system preference

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      primary: grey
      accent: red
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to light mode    


  # Configures icons
  icon:
    # Sets homepage icon
    logo: sfe-logo

    # Sets repo icon to GitHub icon
    repo: fontawesome/brands/github
    
    # Sets icons for "view source" (commented out) and "edit this page" buttons
    edit: material/file-document-edit-outline
    # view: material/file-code-outline

    # Admonition Icons (callout boxes)
    admonition:
      note: octicons/tag-16
      abstract: octicons/checklist-16
      info: octicons/info-16
      tip: simple/sparkfun
      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
      # Add custom admonitions
      github: simple/github
      arduino: simple/arduino
      python: simple/python
      code: fontawesome/regular/file-code
      terminal: octicons/terminal-16
      serial: fontawesome/solid/display
      hot: material/fire-alert
      # Permalink icon
      link: octicons/link-16


  # Adds overrides for icons, html, etc.
  custom_dir: overrides



# Included MkDocs plugins
# Add the installation of any new plugins to the ./github/workflows/mkdocs.yml file also
plugins:
  # Default search plugin
  - search

  # Allows formatting (code block, icons, etc.) in headings and titles
  - typeset

  # Redirects page navigation
  - redirects:
      redirect_maps:
        'index.md': 'introduction.md'

  # # Add revision date
  # - git-revision-date-localized:
  #     enable_creation_date: true
  #     type: timeago

  # # Add git committers at bottom of the page
  # - git-committers:
  #     repository: sparkfun/SparkFun_IoT_Brushless_Motor_Driver
  #     branch: main

  # # Add git authors at bottom of the page
  # - git-authors
  
  # Enables use of Git submodules and larger code base
  - monorepo



# Included Markdown extensions
markdown_extensions:
  # Adds support for syntax highlighting of code blocks
  - pymdownx.highlight:
      anchor_linenums: true
  
  # Adds support for syntax highlighting of inline code blocks
  - pymdownx.inlinehilite

  # Adds the ability to embed content from arbitrary files
  - pymdownx.snippets:
      # base_path: ['./docs']
      url_download: true
      url_max_size: 0
      url_timeout: 0
      url_request_headers: {}
  
  # Allows embedding of code blocks in other elements
  - pymdownx.superfences
  
  # Allows admonition extension to collapse the call-out boxes
  - pymdownx.details
  
  # Allows the use of tabs in the document
  - pymdownx.tabbed:
      alternate_style: true 
  
  # Allows the use of Markup syntax
  - pymdownx.betterem:
      smart_enable: all
  
  # Allows the use of in-text highlighting in Markdown syntax
  - pymdownx.mark
  
  # Allows the use of superscript/subscript formatting in Markdown syntax
  - pymdownx.caret
  
  # Allows the use of strikeout formatting in Markdown syntax
  - pymdownx.tilde
  
  # Allows the use of keyboard button formatting in Markdown syntax
  - pymdownx.keys
  
  # Allows the use of tables in Markdown syntax
  - tables
  
  # Allows the use of admonition/call-out boxes
  - admonition
  
  # Allows the use of Markdown syntax in HTML elements
  - md_in_html
  
  # Allows the use of HTML syntax in Markdown elements
  - attr_list
  
  # Allows the use of definition list formatting in Markdown syntax
  - def_list
  
  # Allows the use of bundled and custom icons and emojis
  - pymdownx.emoji:
      emoji_index: !!python/name:materialx.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg
      options:
        custom_icons:
          - overrides/.icons
  
  #  Allows for rendering of block and inline block equations
  - pymdownx.arithmatex:
      generic: true
  
  # Adds permalink icon to headers
  - toc:
      permalink: ''
      # Link: &#x1F517; 🔗
      # Chain: &#x26D3; ⛓



extra:
  # Configures the hyperlink for the logo in the header
  homepage: https://www.sparkfun.com

  # Configures social icons in the footer
  social:
    - icon: sfe-logo
      link: https://www.sparkfun.com/products/22132
    - 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



# Configures styling for PDF rendering and webpage layout
extra_css:
  - stylesheet/extra.css



# Enables support for rendering block and inline block equations through MathJax
extra_javascript:
  # Enables support for rendering block and inline block equations through MathJax
  - javascript/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js



# Configures webpage navigation
nav:
  - Getting Started:
    - Introduction: introduction.md
    - Hardware Overview: hardware_overview.md
    - Hardware Assembly: hardware_assembly.md
    - Software - Arduino IDE:
      - Installation & Setup: software_overview.md
      - Example - Basic: example-BLDC.md
      # - Example - FOC Algorithm: example-FOC-position.md
      # - Example - FOC Algorithm: example-FOC-current.md
      - Example - Factory Reset: example-factory.md
  - Resources:
    - Hardware Resources: resources.md
    - Background Information: background.md
  - Support:
    - Troubleshooting Tips: troubleshooting_tips.md
    - Submit Issues: github/file_issue.md
    - Contribute: github/contribute.md