mkdocs.yml

site_name: Armbian Documentation
site_author: "Armbian team"

copyright: Copyright © 2015 - 2024 Armbian team
repo_url: https://github.com/armbian/documentation
repo_name: armbian/documentation

theme: 
    name: material
    custom_dir: overrides
    logo: images/logo.svg
    icon:
      repo: fontawesome/brands/github-alt
    palette:
        - scheme: default
          primary: red
          accent: red
          toggle:
            icon: material/toggle-switch-off-outline 
            name: Switch to dark mode
        - scheme: slate
          primary: red
          accent: red
          toggle:
            icon: material/toggle-switch
            name: Switch to light mode
    favicon: images/logo.png
    features:
        - navigation.tabs
        - navigation.top
        - toc.integrate

extra:
  analytics:
    provider: google
    property: UA-284946-9
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/armbian
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/armbian

plugins:
   - search
   - with-pdf:
       author: Armbian documentation team
       copyright: © 2024 by Armbian
       cover_title: Armbian documentation
       cover_subtitle: Linux for ARM development boards

markdown_extensions:
  - smarty
  - footnotes
  - mdx_truly_sane_lists
  - toc:
      permalink: True
  - pymdownx.highlight:
      auto_title: true
      linenums: true
      use_pygments: true
  - pymdownx.superfences
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - 'Board' :
        - 'Maintainers_Procedures_and_Guidelines' : 'Board_Maintainers_Procedures_and_Guidelines.md'
    
  - 'Community' :
        - 'Governance' : 'Community_Governance.md'
        - 'IRC' : 'Community_IRC.md'
        - 'Torrent' : 'Community_Torrent.md'
    
  - 'Developer Guide' :
        - 'User Configurations' : 'Developer-Guide_User-Configurations.md'
        - 'Extensions Hooks' : 'Developer-Guide_Extensions-Hooks.md'
        - 'Welcome' : 'Developer-Guide_Welcome.md'
        - 'Build Process' : 'Developer-Guide_Build-Process.md'
        - 'Building with Multipass' : 'Developer-Guide_Building-with-Multipass.md'
        - 'Build Options' : 'Developer-Guide_Build-Options.md'
        - 'Building with Docker' : 'Developer-Guide_Building-with-Docker.md'
        - 'Adding Board Family' : 'Developer-Guide_Adding-Board-Family.md'
        - 'Extensions' : 'Developer-Guide_Extensions.md'
        - 'Testing Procedures' : 'Developer-Guide_Testing-Procedures.md'
        - 'Build Preparation' : 'Developer-Guide_Build-Preparation.md'
    
  - 'Development Code' :
        - 'Review_Procedures_and_Guidelines' : 'Development-Code_Review_Procedures_and_Guidelines.md'
    
  - 'Hardware' :
        - 'Marvell' : 'Hardware_Marvell.md'
        - 'Allwinner A20' : 'Hardware_Allwinner-A20.md'
        - 'Rockchip' : 'Hardware_Rockchip.md'
        - 'Allwinner H5 A64' : 'Hardware_Allwinner-H5-A64.md'
        - 'Allwinner' : 'Hardware_Allwinner.md'
        - 'Allwinner H3' : 'Hardware_Allwinner-H3.md'
        - 'Allwinner H6' : 'Hardware_Allwinner-H6.md'
        - 'Freescale imx6' : 'Hardware_Freescale-imx6.md'
    
  - 'Process' :
        - 'Documentation' : 'Process_Documentation.md'
        - 'Contribute' : 'Process_Contribute.md'
        - 'CI' : 'Process_CI.md'
        - 'Managing_Workflow' : 'Process_Managing_Workflow.md'
        - 'Armbian Task Tracking' : 'Process_Armbian-Task-Tracking.md'
        - 'Merge Policy' : 'Process_Merge-Policy.md'
        - 'Release Model' : 'Process_Release-Model.md'
    
  - 'Quick' :
        - 'facts' : 'Quick_facts.md'
    
  - 'Release' :
        - 'Changelog' : 'Release_Changelog.md'
        - 'Board Maintainers' : 'Release_Board-Maintainers.md'
    
  - 'User Guide' :
        - 'FAQ' : 'User-Guide_FAQ.md'
        - 'Getting Started' : 'User-Guide_Getting-Started.md'
        - 'Recovery' : 'User-Guide_Recovery.md'
        - 'Allwinner_overlays' : 'User-Guide_Allwinner_overlays.md'
        - 'Armbian Config' : 'User-Guide_Armbian-Config.md'
        - 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md'
        - 'Getting Started Download Page' : 'User-Guide_Getting-Started-Download-Page.md'
        - 'Migration_from_Bananian' : 'User-Guide_Migration_from_Bananian.md'
        - 'Fine Tuning' : 'User-Guide_Fine-Tuning.md'
        - 'Board Support Rules' : 'User-Guide_Board-Support-Rules.md'
        - 'Advanced Features' : 'User-Guide_Advanced-Features.md'
        - 'Networking' : 'User-Guide_Networking.md'
        - 'Armbian_overlays' : 'User-Guide_Armbian_overlays.md'