linorobot2/mkdocs.yml at jazzy · linorobot/linorobot2 · 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
site_name: linorobot2
site_description: Build your own autonomous ROS2 robot with Nav2, SLAM Toolbox, and robot_localization
site_url: https://linorobot.github.io/linorobot2
repo_url: https://github.com/linorobot/linorobot2
repo_name: linorobot/linorobot2

docs_dir: docs

theme:
  name: material
  palette:
    primary: indigo
    accent: indigo
  features:
    - navigation.footer
    - navigation.top
    - content.code.copy

nav:
  - Overview: index.md
  - System Configurations: system_configurations.md
  - Installation: installation.md
  - Base Controller: base_controller.md
  - Odometry: odometry.md
  - Setting Up Sensors: sensors.md
  - Setting Up Transforms: transforms.md
  - Mapping: mapping.md
  - Navigation: navigation.md
  - Docker: docker.md
  - Simulation Tools: tools.md

markdown_extensions:
  - admonition
  - pymdownx.highlight:
      anchor_linenums: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - tables
  - toc:
      permalink: true