mkdocs.yml

site_name: Cyber Hack
site_author: Gavin Gao
site_url: https://hack.cgabc.xyz/
site_description: Cyber Hack

repo_url: https://github.com/cggos/CyberHack
repo_name: cggos/CyberHack

theme: 
  name: material # readthedocs material
  # logo: material/library
  favicon: images/favicon.png
  icon:
    repo: fontawesome/brands/git-alt
  nav_style: light
  language: 'zh'
  # palette:
  #   primary: 'light blue'
  #   accent: 'indigo' 
  feature:
    tabs: true
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.tabs
    # - navigation.tabs.sticky
    - navigation.sections
    - navigation.expand
    - navigation.prune
    - navigation.indexes
    - navigation.top
    - toc.follow
    # - toc.integrate
    - content.code.annotate

extra_javascript:
    - https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.min.js

plugins:
  - search
  # - social
  - tags

markdown_extensions:
  - abbr
  - meta
  - admonition
  - attr_list
  - def_list
  - footnotes
  - toc:
      permalink: true # "#"
      toc_depth: 5
      separator: "_"
      # slugify: !!python/name:pymdownx.slugs.uslugify_cased
  - codehilite:
      guess_lang: true
      linenums: true
  - pymdownx.inlinehilite
  - pymdownx.arithmatex
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.magiclink
  - pymdownx.caret
  - pymdownx.mark
  - pymdownx.tilde        
  - pymdownx.smartsymbols
  - pymdownx.snippets
  - pymdownx.superfences:
      custom_fences: [
        {name: mermaid, class: mermaid}
      ]
  - pymdownx.highlight:
      auto_title: true
      anchor_linenums: true
      linenums_style: pymdownx-inline
  - pymdownx.tabbed:
      alternate_style: true       
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      # emoji_generator: !!python/name:pymdownx.emoji.to_png
  - pymdownx.tasklist:
      custom_checkbox: true

extra:
  social:
    - icon: fontawesome/brands/github
      link: https://github.com/cggos
      name: cggos on GitHub
    - icon: fontawesome/brands/twitter 
      link: https://x.com/GavnGao
      name: CGABC on X
        
nav:
  - Home: 'index.md'


  - STEM:
    - Overview: stem/README.md
    # - STEM Education: stem/stem_edu.md
    # - STEM DIY: stem/stem_diy.md
    # - STEM Resources: stem/stem_resources.md

    - Visual Programming:
      - Overview: visual_programming/README.md
      # - Scratch: visual_programming/scratch.md
      # - Blockly: visual_programming/blockly.md
      # - Snap!: visual_programming/snap.md
      # - App Inventor: visual_programming/app_inventor.md
      # - Node-RED: visual_programming/node_red.md


  - Network:
    - Overview: network/README.md

    - Secerity:
      - Overview: secerity/README.md
      - Linux Key: secerity/linux_key.md
    
    - Proxy: 
      - Overview: network/proxy/README.md
      - Server: network/proxy/server.md
      - Client: network/proxy/client.md
      - Use: network/proxy/use.md

    - Download Managers:
      - Overview: network/downloader/README.md

    - Serial:
      - Overview: network/serial/README.md
  

  - HAM / IRC:
    - Overview: ham_irc/README.md
    - HAM Radio: ham_irc/ham.md
    - IRC: ham_irc/irc.md
    # - MMDVM: hamirc/mmdvm.md
    # - DMR: hamirc/dmr.md
    # - LoRa: hamirc/lora.md
    # - SDR: hamirc/sdr.md

  - Home Repair/Fix:
    - Overview: home_repair/README.md

  - Home Automation:
    - Overview: home_auto/README.md
    
    - Home Assistant: 
      - Overview: home_auto/ha/README.md

    - Router:
      - Overview: home_auto/router/README.md
      - OpenWRT: home_auto/router/openwrt.md
      # - DD-WRT: home_auto/router/ddwrt.md
      # - Tomato: home_auto/router/tomato.md
      # - Merlin: home_auto/router/merlin.md

    - NAS: 
      - Overview: home_auto/nas/README.md
      - Synology DS128+: home_auto/nas/synology_nas.md
  #   - Zigbee2MQTT: home_auto/zigbee2mqtt.md
  #   - ESPHome: home_auto/esphome.md
  #   - Tasmota: home_auto/tasmota.md
  #   - OpenHAB: home_auto/openhab.md
  

  - Home DIY:
    - Overview: home_diy/README.md
    - 3D Printing: home_diy/3d_printing.md
    - CNC: home_diy/cnc.md
    - Aluminium Profile (铝型材): home_diy/aluminum_profile.md
    - Quadro: home_diy/quadro.md


  - Embedded:
    - Arduino: embedded/Arduino.md
  

  - Robots DIY:
    - Overview: robots_diy/README.md
    - Sensors: robots_diy/sensors.md


  - Flight DIY:
    - Overview: 'flight_diy/index.md'

    - Hardware & Software:
      - Hardware: 'flight_diy/hsw_cfg/hardware.md'
      - Software: 'flight_diy/hsw_cfg/software.md'
      - Config & Debug: 'flight_diy/hsw_cfg/config_debug.md'
  
    - Development:
      - ROS with Gazebo Simulation: 'flight_diy/development/ros_gazebo.md'
      - Development PX4: 'flight_diy/development/dev_px4.md'

    - Credential:
      - Pilot License: 'flight_diy/credential/pilot_license.md'
  
    - Course:
      - Shenlan: 'flight_diy/course/shenlan.md'