mkdocs.yml

# Project information
site_name: Web3 Pi
site_url: https://setup-guide.web3pi.io/

# Repository
repo_name: Source-Code
repo_url: https://github.com/Web3-Pi/Ethereum-On-Raspberry-Pi


extra_css:
  - stylesheets/extra.css
extra_javascript:
  - stylesheets/extra.js
  
theme:
  name: material
  logo: assets/color.svg
  features:
    - navigation.tabs
    - navigation.tabs.sticky
    - navigation.sections
#    - navigation.path
#    - toc.integrate
    - navigation.top
    - search.suggest
    - search.highlight
    - content.tabs.link
    - content.code.annotation
    - content.code.copy
  icon:
    repo: fontawesome/brands/github
    
  language: en
  palette:
      - scheme: slate 
#    - scheme: default
#      toggle:
#        icon: material/toggle-switch-off-outline 
#        name: Switch to dark mode
#      primary: teal
#      accent: purple 
#    - scheme: slate 
#      toggle:
#        icon: material/toggle-switch
#        name: Switch to light mode    
#      primary: teal
#      accent: lime



nav:
  - About:
    - Web3 Pi: 'index.md'

  - Setup Guide:
    - Introduction: 'GetStart/quick-start.md'
    - Single-Device Mode: 'GetStart/single-device.md'
    - Dual-Devices Mode: 'GetStart/pair-devices.md'
  - Advanced Settings:
    - 'Advanced/Networking.md'
    - UPnP: "Advanced/UPnP.md"
    - Overclocking: 'Advanced/OC.md'
#    - Monitoring: 'Monitoring/monitoring.md'
    - Managing Clients: 'Advanced/services.md'
#   - Boot from external drive: 'foo.md'
    - Config.txt: 'Advanced/config_txt.md'
    - mDSN: "Advanced/mDNS.md"
  - Usage Guides:
      - Transaction Firewall: "Guides/transaction_firewall.md"
      - Solo Staking with Web3 Pi: "Guides/staking.md"
  - Hardware:
    - Recommended Hardware: 'Hardware/recommendedHW.md'
#    - Sample Setups: 'Hardware/sampleSetups.md'
#    - Storage: 'Hardware/storage.md'
#    - microSD: 'Hardware/microSD.md'
    - Backup power (UPS): 'Hardware/UPS.md'
    - PoE Rpi 5: 'Hardware/PoERpi5.md'
#    - Raspberry Pi 5: 'Hardware/pi5.md'
#    - Raspberry Pi 4: 'Hardware/pi4.md'
#    - Raspberry CM4: 'Hardware/CM4.md'
  - Info: 'info.md'
  - Downloads: 'downloads.md'
  - Plugins:
    - Web3 Pi Updater: 'Plugins/web3-pi-updater.md'
    - Web3 Pi Link: 'Plugins/web3-pi-link.md'
    - Script Runner: 'Plugins/script-runner.md'
    - Installation Status Page: 'Plugins/installation-status.md'
    - LCD Dashboard: 'Plugins/lcd-dashboard.md'
    - Basic Ethereum Node Monitor: 'Plugins/basic-node-monitor.md'
    - Basic System Monitor: 'Plugins/basic-system-monitor.md'


plugins:
  - search
  - redirects:
      redirect_maps:
        'Hardware/LCD-dashboard.md': 'https://github.com/Web3-Pi/web3-pi-dashboard'

extra:
  social:
    - icon: fontawesome/brands/github-alt
      link: https://github.com/Web3-Pi/Ethereum-On-Raspberry-Pi
      type: github
      repo: Web3-Pi/Ethereum-On-Raspberry-Pi
    # - icon: fontawesome/brands/twitter
    #   link: https://twitter.com/Web3Pi
    - icon: fontawesome/brands/discord
      link: https://discord.gg/aDMw5zeUZ4

markdown_extensions:
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - admonition
  - pymdownx.arithmatex:
      generic: true
  - footnotes
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
      combine_header_slug: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
  - pymdownx.mark
  - attr_list
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:materialx.emoji.to_svg

copyright: |
  &copy; 2025 <a href="https://github.com/Web3-Pi/Ethereum-On-Raspberry-Pi"  target="_blank" rel="noopener">Web3 Pi</a>