mkdocs.yml

site_name: Armbian Documentation
site_author: "Armbian team"
site_url: https://docs.armbian.com
site_description: Official documentation for Armbian OS and Armbian build framework
copyright: Copyright © 2013 - 2024 Armbian.com
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:
        - content.action.edit
        - content.action.view
        - content.code.copy
        - navigation.tabs
        - navigation.top
        - toc.integrate

extra_css:
  - css/armbian-extra.css

extra:
  analytics:
    provider: google
    property: UA-284946-9
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/armbian
    - icon: fontawesome/solid/house
      link: https://www.armbian.com/
    - 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
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences:
      - name: mermaid
        class: mermaid
        format: !!python/name:pymdownx.superfences.fence_code_format
  - markdown.extensions.admonition # Highlighted warning/info blocks
  - markdown.extensions.attr_list # Set custom HTML attributes {: }
  - markdown.extensions.footnotes # Footnotes [^1]
  - markdown.extensions.meta # Define meta data (page title and description) at the top of the Markdown document
  - markdown.extensions.smarty # Automatically convert dashes, underscore, three-dots and quotes to text symbols
  - markdown.extensions.tables # Tables
  - markdown.extensions.toc: # Add HTML id attribute to headers
      permalink: true # Headers are links to themselves
  - pymdownx.betterem: # More intuitive emphasis handling
      smart_enable: all # Even smarter for both (asterisk and underscore) syntax => GitHub-like
  - pymdownx.details # Collapsible details blocks
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - pymdownx.keys # Keyboard key symbols
  - pymdownx.magiclink: # Auto-links non angle bracket URLs and email addresses and allows to shorten and visualise Git repo links
      repo_url_shortener: true
      repo_url_shorthand: true
  - pymdownx.superfences # Indented code blocks, e.g. within lists, admonition, details or tabbed blocks, implies pymdownx.highlight
  - pymdownx.tabbed: # Tabbed content blocks
      alternate_style: true
      slugify: !!python/object/apply:pymdownx.slugs.slugify
        kwds:
          case: lower
      combine_header_slug: true

nav:

  - 'ARMBIAN OS':
        - 'Overview': 'index.md'
        - 'Getting Started' : 'User-Guide_Getting-Started.md'
        - 'Networking' : 'User-Guide_Networking.md'
        - 'Fine Tuning' : 'User-Guide_Fine-Tuning.md'
        - 'Basic Troubleshooting' : 'User-Guide_Basic-Troubleshooting.md'
        - 'Recovery' : 'User-Guide_Recovery.md'
        - 'Advanced Features' : 'User-Guide_Advanced-Features.md'
        - 'Firstboot config': 'User-Guide_Autoconfig.md'
        - 'Device tree overlays' : 'User-Guide_Armbian_overlays.md'
        - 'FAQ' : 'User-Guide_FAQ.md'
        - 'Release Model' : 'Process_Release-Model.md'
        - 'Changelog' : 'Release_Changelog.md'
  - 'ARMBIAN CONFIG':
        - 'Overview': 'User-Guide_Armbian-Config.md'
        - 'System': 'User-Guide_Armbian-Config/System.md'
        - 'Network': 'User-Guide_Armbian-Config/Network.md'
        - 'Localisation': 'User-Guide_Armbian-Config/Localisation.md'
  - 'ARMBIAN SOFTWARE':
        - 'Overview': 'User-Guide_Armbian-Software.md'
        - 'Containers': 'User-Guide_Armbian-Software/Containers.md'
        - 'Desktops': 'User-Guide_Armbian-Software/Desktops.md'
        - 'DNS blockers': 'User-Guide_Armbian-Software/DNS.md'
        - 'Home Automation': 'User-Guide_Armbian-Software/HomeAutomation.md'
        - 'Monitoring': 'User-Guide_Armbian-Software/Monitoring.md'
        - 'DevTools': 'User-Guide_Armbian-Software/DevTools.md'
        - 'Management': 'User-Guide_Armbian-Software/Management.md'
        - 'Media': 'User-Guide_Armbian-Software/Media.md'
        - 'Netconfig': 'User-Guide_Armbian-Software/Netconfig.md'

  - 'ARMBIAN BUILD FRAMEWORK' :
        - 'Overview' : 'Developer-Guide_Overview.md'
        - 'Getting Started' : 'Developer-Guide_Build-Preparation.md'
        - 'Build Commands' : 'Developer-Guide_Build-Commands.md'
        - 'Build Switches' : 'Developer-Guide_Build-Switches.md'
        - 'User Configurations' : 'Developer-Guide_User-Configurations.md'
        - 'Extensions Hooks' : 'Developer-Guide_Extensions-Hooks.md'
        - 'Building with Multipass' : 'Developer-Guide_Building-with-Multipass.md'
        - 'Building with Docker' : 'Developer-Guide_Building-with-Docker.md'
        - 'Extensions' : 'Developer-Guide_Extensions.md'

  - 'ARMBIAN COMMUNITY' :
        - 'Forums' : 'Community_Forums.md'
        - 'Github' : 'Community_Github.md'
        - 'Chat'   : 'Community_IRC.md'

  - 'CONTRIBUTE' :
        - 'Contribute' : 'Process_Contribute.md'
        - 'Automation' : 'Process_CI.md'
        - 'Board Support Rules' : 'User-Guide_Board-Support-Rules.md'