mkdocs.yml

# Copyright (c) 2023 - now Shuaiwen Cui
# Built upon MkDocs & Material for MkDocs

# Project information
site_name: Eureka!
site_url: https://localhost:8000/ # build and run on server, to visit it, type in the server's IP address and port number like this: xxx.xxx.xxx.xxx:8000
site_author: Shuaiwen Cui
site_description: >-
  Welcome to Shaun's rabbit hole. This site serves as a personal knowledge base for me to record my thoughts and ideas. It is also a place for me to share my knowledge and experience with the world. I hope you find something useful here.

# Repository
repo_name: Shuaiwen-Cui/Infinity
repo_url: https://github.com/Shuaiwen-Cui/Infinity.git/

# Copyright
copyright: Copyright © 2023 ~ now | 🚀 Shuaiwen Cui (Shaun)

# Configuration
theme:
  custom_dir: material/overrides
  name: material
  logo: static/images/logo.png
  language: en
  features:
    - announce.dismiss
    - content.action.edit
    - content.action.view
    - content.code.annotate
    - content.code.copy
    - content.code.select
    # - content.tabs.link
    - content.tooltips
    - header.autohide
    # - navigation.expand # expand the side navigation bar by default
    - navigation.footer
    - navigation.indexes # documents can be directly attached to sections, which is particularly useful for providing overview pages
    # - navigation.instant
    - navigation.instant.prefetch # for large file
    - navigation.instant.progress # loading progress bar
    - navigation.path # breadcrumb path on top of page
    # - navigation.prune # only build the visible part of the navigation tree
    # - navigation.sections # navigation - top level will render as sections
    - navigation.tabs
    - navigation.tabs.sticky # tabs stick to the top of the page
    - navigation.top
    - navigation.tracking
    - search.highlight
    - search.share
    - search.suggest
    - toc.follow
    # - toc.integrate # toc is merged into the left navigation bar
  palette:
    - media: "(prefers-color-scheme)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/link
        name: Switch to light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: indigo
      accent: indigo
      toggle:
        icon: material/toggle-switch
        name: Switch to dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: black
      accent: indigo
      toggle:
        icon: material/toggle-switch-off
        name: Switch to system preference
  font:
    text: Roboto
    code: Roboto Mono
  favicon: static/images/logo.png
  icon:
    logo: logo
    previous: fontawesome/solid/angle-left
    next: fontawesome/solid/angle-right
    tag:
      default-tag: fontawesome/solid/tag
      hardware-tag: fontawesome/solid/microchip
      software-tag: fontawesome/solid/laptop-code

# Plugins
plugins:
  - tags
  - blog
  - rss:
      match_path: blog/posts/.* 
      date_from_meta:
        as_creation: date
      categories:
        - categories
        - tags 
  # - social
  - search:
      separator: '[\s\u200b\-_,:!=\[\]()"`/]+|\.(?!\d)|&[lg]t;|(?!\b)(?=[A-Z][a-z])'
  - minify:
      minify_html: true
  # - privacy
  - i18n:
      docs_structure: suffix
      fallback_to_default: true
      reconfigure_material: true
      reconfigure_search: true
      languages:
        - locale: en
          default: true
          name: English
          build: true
          # site_name: Infinity
        - locale: zh
          name: 简体中文
          build: true
          nav_translations: # note that all titles and subtitles in the navigation bar that need to be translated can be put here, but with no indentation
            HOME: 首页
            ABOUT: 关于
            SPONSORSHIP: 赞助
            MATH: 数学
            ANALYSIS: 分析
            ALGEBRA: 代数
            PROBABILITY-STATISTICS: 概率与统计
            COMPLEX-VARIABLE-FUNCTIONS: 复变函数
            DIFFERENTIAL-EQUATION: 微分方程
            OPTIMIZATION 🎯: 最优化 🎯
            DISCRETE-MATH: 离散数学
            INFORMATION-THEORY 🎯: 信息论 🎯
            NUMERICAL-ANALYSIS: 数值分析
            GAME-THEORY 🎯: 博弈论 🎯 
            GEOMETRY-GRAPHICS: 几何与图形学
            # COMPUTER-GRAPHICS-FROM-SCRATCH: 计算机图形学从零开始
            VISUALIZE-ML 🎯: 可视化机器学习 🎯 
            CS: 计算机科学
            THE-MISSING-SEMESTER 🎯: 计算机必学工具 🎯
            COMPUTER-SYSTEM: 计算机系统
            OS: 操作系统
            DATA-BASE 🎯: 数据库 🎯
            NETWORK: 计算机网络
            DATA-STRUCTURE-ALGO: 数据结构与算法
            COMPILER-THEORY: 编译原理
            SOFTWARE-ENGINEERING: 软件工程
            PARALLEL-COMPUTING: 并行计算
            DISTRIBUTED-SYSTEM: 分布式系统
            CODING: 编程
            CODING-ENV: 编程环境
            COMMAND-LINE: 命令行
            SHELL: 终端解释器SHELL
            ROOKIE 🎯🏆: 编程新手村 🎯🏆
            C/C++ 🎯: C/C++ 🎯
            C: C
            C-NOTES: C笔记
            C++: C++
            C++-NOTES: C++笔记
            MAKE-SERIES: MAKE系列
            PYTHON: PYTHON
            ROADMAP: 路线图
            HTML/CSS/JS: HTML/CSS/JS
            HTML: 超文本标记语言
            CSS: 级联样式表
            JAVASCRIPT: JAVASCRIPT
            WEB-DEV: 浏览器端开发
            DATABASE 🎯: 数据库 🎯
            RDBMS: 关系型数据库管理系统
            NOSQL: 非关系型数据库
            TSDB: 时序数据库
            GRAPHDB: 图数据库
            EMBEDDED-SYS: 嵌入式系统
            STM32 🎯: STM32 🎯
            ESP32 🎯: ESP32 🎯
            THEORY: 理论
            ELECTRONICS: 电子学
            CIRCUITS: 电路
            SIGNAL-SYSTEM: 信号与系统
            FREERTOS: 实时操作系统
            LINUX: LINUX
            BASICS 🎯: 基础 🎯
            EMBED-BASICS: 嵌入式基础
            JUST: 江协科技
            YOUNGTALK: 洋桃科技
            EMBEDFIRE: 野火科技
            ALIENTEK: 正点原子
            DIGIKEY: 德捷电子
            STM32CUBE-DEV 🎯: STM32CUBE开发 🎯
            REFERENCE: 参考链接
            SIMULATION: 仿真
            DEVKIT 🎯: 开发板 🎯
            ARDUINO: ARDUINO
            STM32: STM32
            ESP32: ESP32
            # OPENMV: OPENMV
            RASPBERRYPI: 树莓派
            JETSON: 英伟达JETSON
            IDE 🎯: 集成开发环境 🎯
            MYSETUP 🎯: 我的工具链 🎯
            KEIL 🎯: KEIL 🎯
            OFFICIAL-GUIDE-MDK4: MDK4官方指南
            OFFICIAL-GUIDE-MDK5: MDK5官方指南
            PREFACE: 前言
            MDK-INTRODUCTION: MDK简介
            CMSIS: CMSIS库
            SOFTWARE-COMPONENTS: 软件组件
            CREATE-APP: 创建应用
            DEBUG-APP: 调试应用
            MDK-MIDDLEWARE: MDK中间件
            PLATFORMIO: PLATFORMIO
            DEV-FRAMEWORK: 开发框架
            # CMSIS 🎯: Cortex微控制器软件接口标准 🎯
            # STM-HAL 🎯: 意法半导体硬件抽象层(STM-HAL) 🎯
            # ESP-IDF 🎯: 乐鑫物联网开发框架(ESP-IDF) 🎯
            USEFUL-LIB 🎯: 常用嵌入式开发库 🎯
            DSP: 数字信号处理
            WAVELET-TRANSFORM 🎯: 小波变换 🎯
            INDEPENDENT-COMPONENT-ANALYSES 🎯: 独立成分分析 🎯
            NOTE-DSP-STUFF 🎯: “DSP相关内容”笔记 🎯
            TIME-FREQ-ANA 🎯: 时频分析 🎯
            EMD 🎯: 经验模态分解 🎯
            EMD-BASICS: 经验模态分解基础
            IMF: 瞬时频率
            EMD-MATLAB: EMD MATLAB实现
            HILBERT-HUANG-TRANSFORM: 希尔伯特-黄变换
            HILBERT-ANA-SERIES: 希尔伯特分析系列
            EEMD: 集合经验模态分解
            CEEMD: 完备集合经验模态分解
            CEEMDAN: 适应性噪声完备集合经验模态分解
            VMD 🎯: 变分模态分解 🎯
            ICEEMDAN: 改进的适应性噪声完备集合经验模态分解
            LMD: 局部模态分解
            EWT: 经验小波变换
            DWT 🎯: 离散小波变换 🎯
            WPT 🎯: 小波包变换 🎯
            PERCEPTION: 感知
            SENSORS-CIVIL-ENGINEERING: 土木工程中的传感器
            CONTROL: 控制
            ACTUATION: 执行
            ROS 🎯: 机器人操作系统 🎯
            OFFICIAL-GUIDE: 官方指南
            INSTALLATION: 安装
            DISTRIBUTION: 发行版
            TUTORIALS: 教程
            CLI-TOOLS: 命令行工具
            CLIENT-LIBRARIES: 客户端库
            HANDSON-ROS: 动手学ROS
            P1-GET-STARTED: P1-入门
            VISUALIZATION: 可视化    
            WEB-BASED: WEB端
            CLIENT-BASED: 客户端        
            IOT: 物联网
            WSN 🎯: 无线传感器网络 🎯
            MQTT: 消息队列遥测传输协议
            HOME-ASSISTANT: 家居助手
            BROKER: 代理
            CLIENT: 客户端
            CLOUD: 云
            CLOUD-TECH 🎯: 云技术 🎯
            HANDS-ON 🎯: 上手实践 🎯
            Have A Server: 拥有一台服务器
            Server Configuration: 服务器配置
            Get A Domain Name: 获得一个域名
            AI: 人工智能
            BASICS 🎯: 基础 🎯
            FRAMEWORKS 🎯: 框架 🎯
            GAUSSIAN-PROCESS 🎯: 高斯过程 🎯
            LNN: 线性神经网络
            MLP: 多层感知机
            CNN: 卷积神经网络
            RNN: 循环神经网络
            TRANSFORMER: “变形金刚”
            GNN 🎯: 图神经网络 🎯
            GAN: 生成对抗网络
            RL 🎯: 强化学习 🎯
            LHY-RL: 李宏毅强化学习
            EASY-RL: 蘑菇书强化学习 
            RL Basics: 强化学习基础
            Markov Decision Process (MDP): 马尔可夫决策过程 (MDP)
            Q Table Methods (Q-Learning): Q表方法(Q学习)
            Policy Gradient Methods (PG): 策略梯度方法 (PG)
            Proximal Policy Optimization (PPO): 近端策略优化 (PPO)
            Deep Q-Network (DQN): 深度Q网络 (DQN)
            DQN Advanced: DQN进阶
            DQN Continuous Action: DQN连续动作
            Actor-Critic Method (AC): 演员-评论家方法 (AC)
            Sparse Rewards: 稀疏奖励
            Imitation Learning: 模仿学习
            Deep Deterministic Policy Gradient (DDPG): 深度确定性策略梯度 (DDPG)
            AlphaStar: AlphaStar算法
            BO 🎯: 贝叶斯优化 🎯
            FL 🎯: 联邦学习 🎯
            MULTI-AGENT 🎯: 多智能体 🎯
            TL 🎯: 迁移学习 🎯
            NLP: 自然语言处理
            CV 🎯: 计算机视觉 🎯
            NOTE-D2L 🎯: 动手学深度学习 🎯
            CH1-INTRO: CH1-引言
            CH2-PRE: CH2-预备知识
            CH3-LNN 🎯: CH3-线性神经网络 🎯
            CH4-MLP 🎯: CH4-多层感知机 🎯
            CH5-DL-COMPUTING: CH5-深度学习计算
            CH6-CNN: CH6-卷积神经网络
            CH7-MODERN-CNN: CH7-现代卷积神经网络
            SHM: 结构健康监测
            STRUCTURAL-DYNAMICS 🎯: 结构动力学 🎯
            SOFTWARE: 软件
            OPENSEES: OPENSEES
            RESPONSE-CALCULATION: 响应计算
            NSEL-REPORT: NSEL报告
            DEV: 开发
            DEVENV: 开发环境
            LATEX: LATEX
            REMOTE-CONTROL: 远程控制
            RUSTDESK: RUSTDESK
            VSCODE-REMOTE-SSH: VSCODE远程SSH
            CLOUD-SYNC: 云同步
            EMBEDDED-SYS-DEV: 嵌入式系统开发
            # EMBEDDED: 嵌入式
            # MCU51: 单片机51
            # CH01-PRELIMINARIES: CH01-预备知识
            # CH02-LED: CH02-LED点灯
            # CH03-BUTTON: CH03-按键控制
            # MCU32: 单片机32
            # MPU: 微处理器
            GADGETS: 小工具
            SERIAL-ASSISTANT: 串口助手
            CHARACTER-EXTRACTION: 字模提取
            BACKGROUND-REMOVAL: 背景去除
            WATERMARK-ADDING: 水印添加
            PLOTNEURALNET: 绘制神经网络
            STM32-DEV-BOARDS: STM32开发板
            STM32-DEV-REF: STM32开发参考
            ESP32-DEV-BOARDS: ESP32开发板
            ESP32-DEV-REF: ESP32开发参考
            MCU-SYS 🎯: 微控制器系统 🎯
            MPU-SYS 🎯: 微处理器系统 🎯
            XNODE 🎯: XNODE 🎯
            XNODE-DOCS: XNODE文档
            BASIC-VERSION: 基础版本
            FRONT-END: 前端
            BACK-END: 后端
            RESEARCH: 研究
            NODE 🎯: 节点 🎯
            MCU-NODE-STM32H743 🎯: 微控制器节点-STM32H743 🎯
            MCU-NODE-ESP32S3: 微控制器节点-ESP32S3
            SYSTEM 🎯: 系统 🎯
            PROJECT: 项目
            TECH-BLOG: 技术博客
            WAREHOUSE: 资源仓库
            EMBEDDED-DEV: 嵌入式开发 
# # Hooks
# hooks:
#   - material/overrides/hooks/shortcodes.py
#   - material/overrides/hooks/translations.py 

# Additional configuration 
extra:
  generator: false
  status:
    new: Recently added
    deprecated: Deprecated
  analytics:
    provider: google
    property: !ENV GOOGLE_ANALYTICS_KEY
    # property: GOOGLE_ANALYTICS_KEY
    feedback:
      title: Was this page helpful?
      ratings:
        - icon: material/thumb-up-outline
          name: This page was helpful
          data: 1
          note: >-
            Thanks for your feedback!
        - icon: material/thumb-down-outline
          name: This page could be improved
          data: 0
          note: >- 
            Thanks for your feedback! Help us improve this page by
            using our <a href="..." target="_blank" rel="noopener">feedback form</a>.
  # alternate:
  #   - name: English
  #     link: /en/ 
  #     lang: en
  #   - name: Chinese
  #     link: /zh/
  #     lang: zh
  social:
    - icon: fontawesome/solid/house
      link: http://www.cuishuaiwen.com/
    - icon: fontawesome/brands/github
      link: https://github.com/Shuaiwen-Cui
    - icon: fontawesome/brands/linkedin
      link: https://www.linkedin.com/in/shaun-shuaiwen-cui/
    - icon: fontawesome/brands/researchgate
      link: https://www.researchgate.net/profile/Shuaiwen-Cui
    - icon: fontawesome/brands/orcid
      link: https://orcid.org/0000-0003-4447-6687
    - icon: fontawesome/brands/twitter
      link: https://twitter.com/ShuaiwenC
  tags:
    Default: default-tag
    Hardware: hardware-tag
    Software: software-tag
  # consent:
  #   title: Cookie consent
  #   description: >- 
  #     We use cookies to recognize your repeated visits and preferences, as well
  #     as to measure the effectiveness of our documentation and whether users
  #     find what they're searching for. With your consent, you're helping us to
  #     make our documentation better.

# Extra Configuration 
extra_javascript:
  # - https://giscus.app/client.js
  - /CODING/PYTHON/Book1_Python-For-Beginners_编程不难.pdf
  # - javascripts/katex.js 
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/katex.min.js  
  # - https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.16.7/contrib/auto-render.min.js
  - javascripts/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
  - javascripts/embed-pdf.js

# Extensions
markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - toc:
      permalink: true
  - pymdownx.arithmatex:
      generic: true
  - pymdownx.betterem:
      smart_enable: all
  - pymdownx.caret
  - pymdownx.details
  - pymdownx.emoji:
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
      emoji_index: !!python/name:material.extensions.emoji.twemoji
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.keys
  - pymdownx.magiclink:
      normalize_issue_symbols: true
      repo_url_shorthand: true
      user: squidfunk
      repo: mkdocs-material
  - pymdownx.mark
  - pymdownx.smartsymbols
  - pymdownx.snippets:
      auto_append:
        - includes/mkdocs.md
  - 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.tasklist:
      custom_checkbox: true
  - pymdownx.tilde

# Page Navigation Tree
nav:
  - HOME: 
      - "index.md"
      - ABOUT: "./HOME/about.md"
      - SPONSORSHIP: "./HOME/sponsorship.md"
  - MATH:
      - MATH: "./MATH/math.md"
      - ANALYSIS: "./MATH/ANALYSIS/analysis.md"
      - ALGEBRA: "./MATH/ALGEBRA/algebra.md"
      - PROBABILITY-STATISTICS: "./MATH/PROBABILITY-STATISTICS/probability-statistics.md"
      - COMPLEX-VARIABLE-FUNCTIONS: "./MATH/COMPLEX-VARIABLE-FUNCTIONS/complex-variable-functions.md"
      - DIFFERENTIAL-EQUATION: "./MATH/DIFFERENTIAL-EQUATION/differential-equation.md"
      - OPTIMIZATION 🎯: "./MATH/OPTIMIZATION/optimization.md"
      - DISCRETE-MATH: "./MATH/DISCRETE-MATH/discrete-math.md"
      - INFORMATION-THEORY 🎯: "./MATH/INFORMATION-THEORY/information-theory.md"
      - NUMERICAL-ANALYSIS: "./MATH/NUMERICAL-ANALYSIS/numerical-analysis.md"
      - GAME-THEORY 🎯: "./MATH/GAME-THEORY/game-theory.md"
      - GEOMETRY-GRAPHICS: "./MATH/GEOMETRY-GRAPHICS/geometry-graphics.md"
          # - GEOMETRY-GRAPHICS: "./MATH/GEOMETRY-GRAPHICS/geometry-graphics.md"
          # - COMPUTER-GRAPHICS-FROM-SCRATCH: "./MATH/GEOMETRY-GRAPHICS/COMPUTER-GRAPHICS/computer-graphics.md"
      - VISUALIZE-ML 🎯: "./MATH/VISUALIZE-ML/visualize-ml.md"
  - CS: 
      - CS: "./CS/CS.md"
      - THE-MISSING-SEMESTER 🎯: "./CS/THE-MISSING-SEMESTER/the-missing-semester.md"
      - COMPUTER-SYSTEM: "./CS/COMPUTER-SYS/computer-sys.md"
      - OS: "./CS/OS/os.md"
      - DATA-BASE 🎯: "./CS/DATA-BASE/data-base.md"
      - NETWORK: "./CS/NETWORK/network.md"
      - DATA-STRUCTURE-ALGO: "./CS/DATA-STRUCTURE-ALGO/data-structure-algo.md"
      - COMPILER-THEORY: "./CS/COMPILER-THEORY/compiler-theory.md"
      - SOFTWARE-ENGINEERING: "./CS/SOFTWARE-ENG/software-eng.md"
      - PARALLEL-COMPUTING: "./CS/PARALLEL-COMPUTING/parallel-computing.md"
      - DISTRIBUTED-SYSTEM: "./CS/DISTRIBUTED-SYS/distributed-sys.md"
  - CODING: 
      - "./CODING/coding.md"
      - CODING-ENV: "./CODING/CODING-ENV/coding-env.md"
      - COMMAND-LINE: "./CODING/COMMAND-LINE/command-line.md"
      - SHELL: "./CODING/SHELL/shell.md"
      - ROOKIE 🎯🏆: 
          - RUNOOB 🎯:
              - "./CODING/ROOKIE/rookie.md"
              - C: "./CODING/ROOKIE/C/c.md"
              - C++: "./CODING/ROOKIE/C++/c++.md"
              - PYTHON: "./CODING/ROOKIE/PYTHON/python.md"
              - SQL: "./CODING/ROOKIE/SQL/sql.md"
      - C/C++ 🎯:
          # - "./C-C++/c-c++.md"
          - C: "./CODING/C-C++/C/c.md"
          - C-NOTES: "./CODING/C-C++/C-NOTES/c-notes.md" 
          - C++: "./CODING/C-C++/C++/c++.md"
          - C++-NOTES: 
              - "./CODING/C-C++/C++-NOTES/c++-notes.md"
              - CH01: "./CODING/C-C++/C++-NOTES/CH01/ch01.md"
              - CH02: "./CODING/C-C++/C++-NOTES/CH02/ch02.md"
              - CH03: "./CODING/C-C++/C++-NOTES/CH03/ch03.md"
              - CH04: "./CODING/C-C++/C++-NOTES/CH04/ch04.md"
          - MAKE-SERIES: "./CODING/C-C++/MAKE-SERIES/make-series.md"
      - PYTHON 🎯: 
          - "./CODING/PYTHON/python.md"
          - ROADMAP: "./CODING/PYTHON/ROADMAP/roadmap.md"
      - MICROPYTHON: "./CODING/MICROPYTHON/micropython.md"
      - HTML/CSS/JS: 
          - HTML: "./CODING/HTML-CSS-JS/HTML/html.md"
          - CSS: "./CODING/HTML-CSS-JS/CSS/css.md"
          - JAVASCRIPT: "./CODING/HTML-CSS-JS/JS/js.md"
      - WEB-DEV: 
          - "./CODING/WEB-DEV/web-dev.md"
          - FLASK 🎯: "./CODING/WEB-DEV/FLASK/flask.md"
          - DJANGO 🎯: "./CODING/WEB-DEV/DJANGO/django.md"
      - DATABASE 🎯:
          - RDBMS:
            - MYSQL: "./CODING/DATABASE/RDBMS/MYSQL/mysql.md"
            - POSTGRESQL 🎯: "./CODING/DATABASE/RDBMS/POSTGRESQL/postgresql.md"
          - NOSQL:
            - MONGODB 🎯: "./CODING/DATABASE/NOSQL/MONGODB/mongodb.md"
          - TSDB:
            - INFLUXDB 🎯: "./CODING/DATABASE/TSDB/INFLUXDB/influxdb.md"
            - TIMESCALEDB 🎯: "./CODING/DATABASE/TSDB/TIMESCALEDB/timescaledb.md"
            - TDENGINE: "./CODING/DATABASE/TSDB/TDENGINE/tdengine.md"
            - IOTDB: "./CODING/DATABASE/TSDB/IOTDB/iotdb.md"
          - GRAPHDB:
            - NEO4J 🎯: "./CODING/DATABASE/GRAPHDB/NEO4J/neo4j.md"
  - EMBEDDED-SYS: 
      - "./EMBEDDED-SYS/embedded-sys.md"
      - STM32 🎯: "./EMBEDDED-SYS/STM32/stm32.md"
      - ESP32 🎯: "./EMBEDDED-SYS/ESP32/esp32.md"
      - THEORY:
          - ELECTRONICS: "./EMBEDDED-SYS/THEORY/ELECTRONICS/electronics.md"
          - CIRCUITS: "./EMBEDDED-SYS/THEORY/CIRCUITS/circuits.md"
          - SIGNAL-SYSTEM: "./EMBEDDED-SYS/THEORY/SIGNAL-SYSTEM/signal-system.md"
          - FREERTOS: "./EMBEDDED-SYS/THEORY/FREERTOS/freertos.md"
          - LINUX: "./EMBEDDED-SYS/THEORY/LINUX/linux.md"
      - BASICS 🎯: 
          - EMBED-BASICS: 
              -  "./EMBEDDED-SYS/BASICS/embed-basics.md"
              - JUST: "./EMBEDDED-SYS/BASICS/JUST/just.md"
              - YOUNGTALK: "./EMBEDDED-SYS/BASICS/YOUNGTALK/youngtalk.md"
              - EMBEDFIRE: "./EMBEDDED-SYS/BASICS/EMBEDFIRE/embedfire.md"
              - ALIENTEK: "./EMBEDDED-SYS/BASICS/ALIENTEK/alientek.md"
              - DIGIKEY: "./EMBEDDED-SYS/BASICS/DIGIKEY/digikey.md"
              - STM32CUBE-DEV 🎯: "./EMBEDDED-SYS/BASICS/STM32CUBE-DEV/stm32cube-dev.md"
              - REFERENCE: "./EMBEDDED-SYS/BASICS/REFERENCE/reference.md"
      - SIMULATION: 
          # - "./EMBEDDED-SYS/SIMULATION/simulation.md"
          - RENODE: "./EMBEDDED-SYS/SIMULATION/RENODE/renode.md"
          - WOKWI: "./EMBEDDED-SYS/SIMULATION/WOKWI/wokwi.md"
      - DEVKIT 🎯: 
          - ARDUINO: "./EMBEDDED-SYS/DEVKIT/ARDUINO/arduino.md"
          - STM32: 
              - "./EMBEDDED-SYS/DEVKIT/STM32/stm32.md"
              - STM32H743IIT: "./EMBEDDED-SYS/DEVKIT/STM32/STM32H743IIT/stm32h743iit.md"
              - STM32MP157: "./EMBEDDED-SYS/DEVKIT/STM32/STM32MP157/stm32mp157.md"
          - ESP32: "./EMBEDDED-SYS/DEVKIT/ESP32/esp32.md"
          # - OPENMV: "./EMBEDDED-SYS/DEVKIT/OPENMV/openmv.md"
          - RASPBERRYPI: "./EMBEDDED-SYS/DEVKIT/RASPBERRYPI/raspberrypi.md"
          - JETSON: "./EMBEDDED-SYS/DEVKIT/JETSON/jetson.md"
      - IDE 🎯: 
          - "./EMBEDDED-SYS/IDE/ide.md"
          - MYSETUP 🎯: "./EMBEDDED-SYS/IDE/MYSETUP/mysetup.md"
          - KEIL 🎯: 
              - "./EMBEDDED-SYS/IDE/KEIL/keil.md"
              - OFFICIAL-GUIDE-MDK4: 
                  - "EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK4/guide-mdk4.md"
              - OFFICIAL-GUIDE-MDK5: 
                  - PREFACE: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/PREFACE/preface.md"
                  - MDK-INTRODUCTION: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/MDK-INTRODUCTION/mdk-introduction.md"
                  - CMSIS: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/CMSIS/cmsis.md"
                  - SOFTWARE-COMPONENTS: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/SOFTWARE-COMPONENTS/software-components.md"
                  - CREATE-APP: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/CREATE-APP/create-app.md"
                  - DEBUG-APP: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/DEBUG-APP/debug-app.md"
                  - MDK-MIDDLEWARE: "./EMBEDDED-SYS/IDE/KEIL/GUIDE-MDK5/MDK-MIDDLEWARE/mdk-middleware.md"
              - MDK6: "./EMBEDDED-SYS/IDE/KEIL/MDK6/mdk6.md"
          - STM32CUBE 🎯: "./EMBEDDED-SYS/IDE/STM32CUBE/stm32cube.md"
          - PLATFORMIO 🎯: "./EMBEDDED-SYS/IDE/PLATFORMIO/platformio.md"
      - DEV-FRAMEWORK:
          - CMSIS 🎯: "./EMBEDDED-SYS/DEV-FRAMEWORK/CMSIS/cmsis.md"
          - STM-HAL 🎯: "./EMBEDDED-SYS/DEV-FRAMEWORK/STM-HAL/stm-hal.md"
          - ESP-IDF 🎯: "./EMBEDDED-SYS/DEV-FRAMEWORK/ESP-IDF/esp-idf.md"  
      - USEFUL-LIB 🎯: "./EMBEDDED-SYS/USEFUL-LIB/useful-lib.md"
  - DSP: 
      - "./DSP/dsp.md"
      - WAVELET-TRANSFORM 🎯: "./DSP/WAVELET-TRANSFORM/wavelet-transform.md"
      - INDEPENDENT-COMPONENT-ANALYSES 🎯: "./DSP/INDEPENDENT-COMPONENT-ANALYSES/ica.md"
      - NOTE-DSP-STUFF 🎯:
          - TIME-FREQ-ANA 🎯:
              - CH01: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH01/tf-ana-ch01.md"
              - CH02: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH02/tf-ana-ch02.md"
              - CH03: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH03/tf-ana-ch03.md"
              - CH04: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH04/tf-ana-ch04.md"
              - CH05: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH05/tf-ana-ch05.md"
              - CH06: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH06/tf-ana-ch06.md"
              - CH07: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH07/tf-ana-ch07.md"
              - CH08: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH08/tf-ana-ch08.md"
              - CH09: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH09/tf-ana-ch09.md"
              - CH10: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH10/tf-ana-ch10.md"
              - CH11: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH11/tf-ana-ch11.md"
              - CH12: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH12/tf-ana-ch12.md"
              - CH13: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH13/tf-ana-ch13.md"
              - CH14: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH14/tf-ana-ch14.md"
              - CH15: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH15/tf-ana-ch15.md"
              - CH16: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH16/tf-ana-ch16.md"
              - CH17: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH17/tf-ana-ch17.md"
              - CH18: "./DSP/NOTE-DSP-STUFF/TIME-FREQ-ANA/CH18/tf-ana-ch18.md" 
          - EMD 🎯: 
              - EMD-BASICS: "./DSP/NOTE-DSP-STUFF/EMD/BASICS/basics.md"
              - IMF: "./DSP/NOTE-DSP-STUFF/EMD/IMF/imf.md"
              - EMD-MATLAB: "./DSP/NOTE-DSP-STUFF/EMD/EMD-MATLAB/emd-matlab.md"
              - HILBERT-HUANG-TRANSFORM: "./DSP/NOTE-DSP-STUFF/EMD/HILBERT-HUANG-TRANSFORM/hilbert-huang-transform.md"
              - HILBERT-ANA-SERIES: "./DSP/NOTE-DSP-STUFF/EMD/HILBERT-ANA-SERIES/hilbert-ana-series.md"
              - EEMD: "./DSP/NOTE-DSP-STUFF/EMD/EEMD/eemd.md"
              - CEEMD: "./DSP/NOTE-DSP-STUFF/EMD/CEEMD/ceemd.md"
              - CEEMDAN: "./DSP/NOTE-DSP-STUFF/EMD/CEEMDAN/ceemdan.md"
              - VMD 🎯: "./DSP/NOTE-DSP-STUFF/EMD/VMD/vmd.md"
              - ICEEMDAN: "./DSP/NOTE-DSP-STUFF/EMD/ICEEMDAN/iceemdan.md"
              - LMD: "./DSP/NOTE-DSP-STUFF/EMD/LMD/lmd.md"
              - EWT: "./DSP/NOTE-DSP-STUFF/EMD/EWT/ewt.md"
              - DWT 🎯: "./DSP/NOTE-DSP-STUFF/EMD/DWT/dwt.md"
              - WPT 🎯: "./DSP/NOTE-DSP-STUFF/EMD/WPT/wpt.md"
  - PERCEPTION: 
      - "./PERCEPTION/perception.md"
      - SENSORS-CIVIL-ENGINEERING: "./PERCEPTION/SENSORS-CIVIL-ENGINEERING/sensors-ce.md"
  - CONTROL: 
      - "./CONTROL/control.md"
  - ACTUATION: 
      - "./ACTUATION/actuation.md"
      - ROS 🎯: 
          - "./ACTUATION/ROS/ros.md"
          - OFFICIAL-GUIDE:
              - INSTALLATION: "./ACTUATION/ROS/OFFICIAL-GUIDE/INSTALLATION/installation.md"
              - DISTRIBUTION: "./ACTUATION/ROS/OFFICIAL-GUIDE/DISTRIBUTION/distribution.md"
              - TUTORIALS: 
                  - CLI-TOOLS: "./ACTUATION/ROS/OFFICIAL-GUIDE/TUTORIALS/CLI-TOOLS/cli-tools.md"
                  - CLIENT-LIBRARIES: "./ACTUATION/ROS/OFFICIAL-GUIDE/TUTORIALS/CLIENT-LIBRARIES/client-libraries.md"      
      - HANDSON-ROS: 
          - "./ACTUATION/HANDSON-ROS/handson-ros.md"
          - P1-GET-STARTED: "./ACTUATION/HANDSON-ROS/P1-GET-STARTED/p1-get-started.md"
  - IOT: 
      - "./IOT/iot.md"
      - WSN 🎯: 
          - "./IOT/WSN/wsn.md"
      - MQTT: 
          - "./IOT/MQTT/mqtt.md"
          - BROKER: "./IOT/MQTT/BROKER/broker.md"
          - CLIENT: "./IOT/MQTT/CLIENT/client.md"
      - HOME-ASSISTANT: "./IOT/HOME-ASSISTANT/home-assistant.md"
  - CLOUD: 
      - "./CLOUD/cloud.md"
      - CLOUD-TECH 🎯: "./CLOUD/CLOUD-TECH/cloud-tech.md"
      - HANDS-ON 🎯:
          - Have A Server: "./CLOUD/HANDS-ON/001-HAVE-A-SERVER/have-a-server.md"
          - Server Configuration: "./CLOUD/HANDS-ON/002-SERVER-CONFIG/server-config.md"
          - Get A Domain Name: "./CLOUD/HANDS-ON/003-DOMAIN-NAME/domain-name.md"
  - AI: 
      # - "./AI/ai.md"
      - BASICS 🎯: "./AI/BASICS/basics.md"
      - FRAMEWORKS 🎯: "./AI/FRAMEWORKS/frameworks.md"
      - GAUSSIAN-PROCESS 🎯: "./AI/GAUSSIAN-PROCESS/gaussian-process.md"
      - LNN: "./AI/LNN/lnn.md"
      - MLP: "./AI/MLP/mlp.md"
      - CNN: "./AI/CNN/cnn.md"
      - RNN: "./AI/RNN/rnn.md"
      - TRANSFORMER: "./AI/TRANSFORMER/transformer.md"
      - GNN 🎯: "./AI/GNN/gnn.md"
      - GAN: "./AI/GAN/gan.md"
      - RL 🎯: 
          - "./AI/RL/rl.md"
          - LHY-RL: "./AI/RL/LHY-RL/lhy-rl.md"
          - EASY-RL: 
              - "./AI/RL/EASY-RL/easy-rl.md"
              - RL Basics: "./AI/RL/EASY-RL/CH01/ch01.md"
              - Markov Decision Process (MDP): "./AI/RL/EASY-RL/CH02/ch02.md"
              - Q Table Methods (Q-Learning): "./AI/RL/EASY-RL/CH03/ch03.md"
              - Policy Gradient Methods (PG): "./AI/RL/EASY-RL/CH04/ch04.md"
              - Proximal Policy Optimization (PPO): "./AI/RL/EASY-RL/CH05/ch05.md"
              - Deep Q-Network (DQN): "./AI/RL/EASY-RL/CH06/ch06.md"
              - DQN Advanced: "./AI/RL/EASY-RL/CH07/ch07.md"
              - DQN Continuous Action: "./AI/RL/EASY-RL/CH08/ch08.md"
              - Actor-Critic Method (AC): "./AI/RL/EASY-RL/CH09/ch09.md"
              - Sparse Rewards: "./AI/RL/EASY-RL/CH10/ch10.md"
              - Imitation Learning: "./AI/RL/EASY-RL/CH11/ch11.md"
              - Deep Deterministic Policy Gradient (DDPG): "./AI/RL/EASY-RL/CH12/ch12.md"
              - AlphaStar: "./AI/RL/EASY-RL/CH13/ch13.md"
      - BO 🎯: "./AI/BO/bo.md"
      - FL 🎯: "./AI/FL/fl.md"
      - MULTI-AGENT 🎯: "./AI/MULTI-AGENT/multi-agent.md"
      - TL 🎯: "./AI/TL/tl.md"
      - NLP: "./AI/NLP/nlp.md"
      - CV 🎯: "./AI/CV/cv.md"
      - NOTE-D2L 🎯: 
          - CH1-INTRO: "./AI/NOTE-D2L/CH1-INTRO/ch1-intro.md"
          - CH2-PRE: "./AI/NOTE-D2L/CH2-PRE/ch2-pre.md"
          - CH3-LNN 🎯: "./AI/NOTE-D2L/CH3-LNN/ch3-lnn.md"
          - CH4-MLP 🎯: "./AI/NOTE-D2L/CH4-MLP/ch4-mlp.md"
          - CH5-DL-COMPUTING: "./AI/NOTE-D2L/CH5-DL-COMPUTING/ch5-dl-computing.md"
          - CH6-CNN: "./AI/NOTE-D2L/CH6-CNN/ch6-cnn.md"
          - CH7-MODERN-CNN: "./AI/NOTE-D2L/CH7-MODERN-CNN/ch7-modern-cnn.md"
  - SHM: 
      - "./SHM/shm.md" 
      - STRUCTURAL-DYNAMICS 🎯: 
          - "./SHM/STRUCTURAL-DYNAMICS/structural-dynamics.md"
          - RESPONSE-CALCULATION: "./SHM/STRUCTURAL-DYNAMICS/RESPONSE-CALCULATION/response-calculation.md"
          - SOFTWARE:
              - OPENSEES: 
                  - "./SHM/STRUCTURAL-DYNAMICS/SOFTWARE/OPENSEES/opensees.md"

      - NSEL-REPORT: "./SHM/NSEL-REPORT/nsel-report.md"
  - DEV: 
      - "./DEV/dev.md"
      - DEVENV: 
          # - "./DEV/DEVENV/devenv.md"
          - LATEX: "./DEV/DEVENV/LATEX/latex.md"
          - REMOTE-CONTROL:
              - "./DEV/DEVENV/REMOTE-CONTROL/remote-control.md"
              - RUSTDESK: "./DEV/DEVENV/REMOTE-CONTROL/RUSTDESK/rustdesk.md"
              - VSCODE-REMOTE-SSH: "./DEV/DEVENV/REMOTE-CONTROL/VSCODE-REMOTE-SSH/vscode-remote-ssh.md"
          - CLOUD-SYNC: "./DEV/DEVENV/CLOUD-SYNC/cloud-sync.md"
          - GIT: "./DEV/DEVENV/GIT/git.md"
          - GITHUB: "./DEV/DEVENV/GITHUB/github.md"
          - DOCKER: "./DEV/DEVENV/DOCKER/docker.md"
          - EMBEDDED-SYS-DEV: "./DEV/DEVENV/EMBEDDED-SYS-DEV/embedded-sys-dev.md"
          - LINUX:
              - UBUNTU: "./DEV/DEVENV/LINUX/UBUNTU/ubuntu.md"
      - GADGETS: 
          - SERIAL-ASSISTANT: "./DEV/GADGETS/SERIAL-ASSISTANT/serial-assistant.md"
          - CHARACTER-EXTRACTION: "./DEV/GADGETS/CHARACTER-EXTRACTION/character-extraction.md"
          - BACKGROUND-REMOVAL: "./DEV/GADGETS/BACKGROUND-REMOVAL/background-removal.md"
          - WATERMARK-ADDING: "./DEV/GADGETS/WATERMARK/watermark.md"
          - PLOTNEURALNET: "./DEV/GADGETS/PLOTNEURALNET/plotneuralnet.md"
      - STM32-DEV-BOARDS: "./DEV/STM32-DEV-BOARDS/stm32-dev-boards.md"
      - STM32-DEV-REF: "./DEV/STM32-DEV-REF/stm32-dev-ref.md"
      - ESP32-DEV-BOARDS: "./DEV/ESP32-DEV-BOARDS/esp32-dev-boards.md"
      - ESP32-DEV-REF: "./DEV/ESP32-DEV-REF/esp32-dev-ref.md"
      - MCU-SYS 🎯:
          - "./DEV/MCU-SYS/mcu-sys.md"
      - MPU-SYS 🎯:
          - "./DEV/MPU-SYS/mpu-sys.md"
      # - EMBEDDED:
      #     # - MCU51: 
      #     #     - CH01-PRELIMINARIES: "./DEV/EMBEDDED/MCU51/CH01-PRE/ch01-pre.md"
      #     #     - CH02-LED: "./DEV/EMBEDDED/MCU51/CH02-LED/ch02-led.md"
      #     #     - CH03-BUTTON: "./DEV/EMBEDDED/MCU51/CH03-BUTTON/ch03-button.md"
      #     - MCU32: 
      #         - "./DEV/EMBEDDED/MCU32/stm32.md"
      #     - MPU: 
      #         - RASPBERRYPI: "./DEV/EMBEDDED/MPU/RASPBERRYPI/raspberrypi.md"
      #         - JETSON-NANO: "./DEV/EMBEDDED/MPU/JETSON-NANO/jetson-nano.md"
      #         - STM32MP157: "./DEV/EMBEDDED/MPU/STM32MP157/stm32mp157.md"
      - XNODE 🎯:
          - XNODE-DOCS: "./DEV/XNODE/XNODE-DOCS/xnode-docs.md"
          - BASIC-VERSION: "./DEV/XNODE/BASIC-VERSION/basic-version.md"
      - FRONT-END: "./DEV/FRONT-END/front-end.md"
      - BACK-END: "./DEV/BACK-END/back-end.md"
      - VISUALIZATION:
          - WEB-BASED: "./DEV/VISUALIZATION/WEB-BASED/web-based.md"
          - CLIENT-BASED: "./DEV/VISUALIZATION/CLIENT-BASED/client-based.md"
  - RESEARCH: 
      - NODE 🎯: 
          - "./RESEARCH/NODE/node.md"
      - SYSTEM 🎯: 
          - "./RESEARCH/SYSTEM/system.md"
  - PROJECT: 
      - "./PROJECT/project.md"
      - TECH-BLOG: "./PROJECT/TECH-BLOG/mkdocs_and_material.md"
      - WAREHOUSE: "./PROJECT/WAREHOUSE/warehouse.md"
      - EMBEDDED-DEV: "./PROJECT/EMBEDDED-DEV/embedded-dev.md"
      - TINYSHM: "./PROJECT/TINYSHM/tinyshm.md"
    
# if there are sub nodes under a node, then there should not be a link right after the node. All the stuff should be placed under the node.

# example

# [incorrect use]
# - CLOUD: "./CLOUD/cloud.md"
#     - CLOUD-TECH: "./CLOUD/CLOUD-TECH/cloud-tech.md"

# [correct use]
# - CLOUD: 
#     - "./CLOUD/cloud.md"
#     - CLOUD-TECH: "./CLOUD/CLOUD-TECH/cloud-tech.md"