canopen-website/mkdocs.yml at main · embedded-office/canopen-website · 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
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
#===================================================================================#
# Site Information
#===================================================================================#
site_name: CANopen Stack
repo_name: "canopen-stack"
repo_url: https://github.com/embedded-office/canopen-stack/
site_url: https://canopen-stack.org/
edit_uri: ""
site_description: CANopen Stack Documentation
site_author: Embedded Office
copyright: Copyright &copy; by <a href="https://www.embedded-office.com/">Embedded Office</a>

#===================================================================================#
# Mkdocs Theme (Material Mkdocs) + Extras
#===================================================================================#
theme:
  name: material
  custom_dir: material
  language: en
  icon:
    logo: material/memory
  favicon: assets/images/favicon/favicon.ico
  font:
    text: Roboto
    code: Roboto Mono
  features:
    - navigation.tabs
    - navigation.instant
    - header.autohide
  palette:
    - scheme: default
      toggle:
        icon: material/toggle-switch-off-outline
        name: Switch to dark mode
    - scheme: slate
      toggle:
        icon: material/toggle-switch
        name: Switch to light mode

extra:
  social:
    - icon: material/home
      link: 'https://canopen-stack.org/'
    - icon: material/github
      link: 'https://github.com/embedded-office/canopen-stack/'
    - icon: material/linkedin
      link: 'https://www.linkedin.com/company/embedded-office/'
  version:
    provider: mike
    default: latest

#===================================================================================#
# Mkdocs Markdown Extentions, Plugins & extras
#===================================================================================#
markdown_extensions:
  - admonition
  - abbr
  - attr_list
  - def_list
  - footnotes
  - meta
  - md_in_html
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.smartsymbols
  - pymdownx.tasklist:
      custom_checkbox: true
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - toc:
      permalink: "#"
      toc_depth: 4
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format

plugins:
  - search
  - mike:
      version_selector: false

extra_css:
  - assets/stylesheets/extra.css

#===================================================================================#
# Mkdocs Navigation Tree
#===================================================================================#
nav:
  - Home: "index.md"
  - Quickstart:
    - Install Environment: "start/installation.md"
    - Repository Structure: "start/structure.md"
    - Quickstart Example: "start/quickstart.md"
  - CANopen Usage:
    - Device Architecture: "usage/architecture.md"
    - CANopen Stack Overview: "usage/overview.md"
    - Controlling the Node: "usage/control.md"
    - Using Object Dictionary: "usage/dictionary.md"
    - Transmit PDO: "usage/tpdo.md"
    - Emergency Errors: "usage/emergency.md"
    - Timed Actions: "usage/actions.md"
    - Callback Interface: "usage/callbacks.md"
    - Configuration: "usage/configuration.md"
  - API Functions:
    - CANopen Node: "api/node.md"
    - Object Dictionary: "api/dictionary.md"
    - Emergency: "api/emergency.md"
    - Network Management: "api/network.md"
    - Object Entry: "api/object.md"
    - TPDO Event: "api/tpdo.md"
    - CAN Interface: "api/interface.md"
    - Timer Handling: "api/timer.md"
    - Parameter Storage: "api/parameter.md"
    - SDO Client: "api/csdo.md"
  - Examples:
    - Firmware Upload: "examples/flash-user-domain.md"
    - Calibration Mode: "examples/setup-calibration-mode.md"
    - Write Serial Number: "examples/write-serial-number.md"
    - Dynamic Dictionary I: "examples/setup-dynamic-object-dictionary.md"
    - Dynamic Dictionary II: "examples/use-dynamic-object-dictionary.md"
    - RTOS and Baremetal: "examples/usage-with-rtos-and-baremetal.md"
  - Hardware Connection:
    - CAN Driver: "hardware/can.md"
    - Timer Driver: "hardware/timer.md"
    - NVM Driver: "hardware/nvm.md"
  - License: "license.md"