Agrync/mkdocs.yml at main · ManuelMuRodriguez/Agrync · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
site_name: Agrync Documentation
site_description: User manual for the Agrync IoT platform
site_author: Agrync Team
repo_url: https://github.com/ManuelMuRodriguez/Agrync
repo_name: ManuelMuRodriguez/Agrync

theme:
  name: material
  language: en
  palette:
    - scheme: default
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
    - scheme: slate
      primary: green
      accent: light green
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  features:
    - navigation.tabs
    - navigation.sections
    - navigation.expand
    - navigation.top
    - search.highlight
    - search.suggest
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

plugins:
  - search

markdown_extensions:
  - admonition
  - pymdownx.details
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.inlinehilite
  - attr_list
  - md_in_html
  - tables
  - footnotes
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg

nav:
  - Home: index.md
  - User Guide:
    - Introduction: user-guide/introduction.md
    - Installation: user-guide/installation.md
    - First Steps: user-guide/first-steps.md
    - User Roles: user-guide/user-roles.md
    - Dashboard: user-guide/dashboard.md
    - Charts: user-guide/charts.md
    - Modbus Configuration:
      - Overview: user-guide/modbus/index.md
      - Devices: user-guide/modbus/devices.md
      - Slaves: user-guide/modbus/slaves.md
      - Variables: user-guide/modbus/variables.md
      - Bulk Import: user-guide/modbus/bulk-import.md
    - Monitoring:
      - Overview: user-guide/monitoring/index.md
      - Modbus Task: user-guide/monitoring/modbus-task.md
      - OPC UA Server Task: user-guide/monitoring/server-opc-task.md
      - OPC to FIWARE Task: user-guide/monitoring/opc-fiware-task.md
    - User Management: user-guide/user-management.md
    - Account Settings: user-guide/account.md
    - Demo Mode: user-guide/demo.md
    - Reference:
      - JSON Import Template: user-guide/reference/json-template.md
  - Technical Manual:
    - Overview: technical/index.md
    - Architecture:
      - System Overview: technical/architecture/index.md
      - Backend: technical/architecture/backend.md
      - Frontend: technical/architecture/frontend.md
    - API Reference:
      - Authentication: technical/api/authentication.md
      - Users: technical/api/users.md
      - Modbus: technical/api/modbus.md
      - Tasks: technical/api/tasks.md
      - OPC UA: technical/api/opc.md
      - FIWARE: technical/api/fiware.md
    - Data Models:
      - User & Roles: technical/data-models/user-roles.md
      - Modbus Hierarchy: technical/data-models/modbus.md
      - Tasks: technical/data-models/tasks.md
    - Background Tasks:
      - Modbus Task: technical/background-tasks/modbus.md
      - ServerOPC Task: technical/background-tasks/server-opc.md
      - OPCtoFIWARE Task: technical/background-tasks/opc-to-fiware.md
    - Authentication & Security: technical/auth-security.md
    - Configuration: technical/configuration.md
    - Testing: technical/testing.md