mkdocs.yml

site_name: NH-Switch Modchip Installation Guide

copyright: Copyright &copy; 2024 <a href="https://github.com/DefenderOfHyrule/defenderofhyrule.github.io" target="_blank">DefenderOfHyrule</a>, Maintained by <a href="https://github.com/DefenderOfHyrule/defenderofhyrule.github.io">DefenderOfHyrule</a>.
site_description: Switch Modchip Installation Guide.
site_author: DefenderOfHyrule
repo_url: https://github.com/DefenderOfHyrule/defenderofhyrule.github.io

theme:
  name: material
  favicon: img/favicon.ico
  features:
    - toc.integrate
    - navigation.instant
    - navigation.expand
    - navigation.sections
    - navigation.tabs
    - navigation.tracking

  palette:
    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      toggle:
        icon: material/brightness-4
        name: Switch to system preference

  icon:
    repo: fontawesome/brands/github
    logo: fontawesome/solid/wrench

nav:
    - Introduction to modchips: index.md
    - Modchip overview:
        - 'Modchip variants': 'modchip/modchip_choice.md'
        - 'Flashing the modchip': 'modchip/flashing_modchip.md'
        - 'Modchip installation Switch': 'modchip/normal.md'
        - 'Modchip installation Switch Lite': 'modchip/lite.md'
        - 'Modchip installation Switch OLED': 'modchip/oled.md'
        - C (DAT0) point methods:
            - 'DAT0 Adapter method' : 'modchip/dat0-adapter.md'
            - 'Kamikaze method' : 'modchip/kamikaze-method.md'
    - Functionality:
       -  'Functionality of modchips': 'functionality/functionality_of_modchips.md'
    - Troubleshooting:
        - 'Error troubleshooting': 'troubleshooting/error_codes.md'
    - Extras:
        - 'Alternative methods to flash your modchip': 'extras/alternate_flashing.md'
        - 'SAMD21 based modchips': 'extras/trinket.md'
        - 'Hardmodding the SD card reader': 'extras/sdreader.md'
        - 'PicoBoot (GC)': 'extras/picoboot.md'
    - Credits:
        - 'Credits': 'credits/credits.md'

markdown_extensions:
  - admonition
  - tables
  - pymdownx.details
  - pymdownx.superfences
  - def_list
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: true
      toc_depth: 3

extra_css:
  - css/custom.css