swarmGPT/mkdocs.yml at main · utiasDSL/swarmGPT · 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
site_name: SwarmGPT - Learning Systems Lab
nav:
  - Home: index.md
  - Getting Started and Installation: getting_started.md
  - Axswarm - Trajectory Planner: axswarm.md
  - Crazyflow - Simulation Software: crazyflow.md
  - Flight Demos: demos.md
  - SwarmGPT User Interaction: choreo.md
  - About the Learning Systems Lab: about.md
  # - Test: crisp_controllers/classes.md

repo_url: https://github.com/utiasDSL/swarmGPT

theme:
  name: material
  custom_dir: overrides
  logo: media/swarmgptlogotiny.png
  favicon: media/swarmgptlogotiny.png
  palette:

    # Palette toggle for light mode
    - media: "(prefers-color-scheme: light)"
      scheme: default
      primary: light green
      accent: deep blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      scheme: slate
      primary: teal
      accent: deep purple
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
  font:
    text: Roboto
    # text: Poppins
    # text: Montserrat
    # text: Tahoma
    # text: Roboto
    code: Source Code Pro
  features:
    - header.autohide
    - content.code.copy
    - content.code.select
    - content.code.annotate
    - content.footnote.tooltips
    - content.tooltips
    - navigation.footer
    - navigation.instant
    - navigation.instant.progress
    - navigation.top
    # - navigation.sections
    - navigation.expand


  icon:
    repo: fontawesome/brands/github


  plugins:
    - search
    - meta-descriptions
    - sitemap

  #- sitemap:
  #    changefreq: monthly
  #    priority: 0.5
  #    sitemap_url: https://yourdomain.com/sitemap.xml

  # - mkdoxy:
  #     projects:
  #       crisp_controllers: # name of project must be alphanumeric + numbers (without spaces)
  #         src-dirs: .
  #         full-doc: True # if you want to generate full documentation
  #         doxy-cfg: # standard doxygen configuration (key: value)
  #           FILE_PATTERNS: "*.cpp *.h*" # specify file patterns to filter out
  #           RECURSIVE: True # recursive search in source directorie


extra:
  social:
    - icon: fontawesome/brands/github
      #link: https://github.com/utiasDSL/crisp_controllers


markdown_extensions:
  - abbr
  - admonition
  - attr_list
  - def_list
  - footnotes
  - md_in_html
  - pymdownx.details
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.highlight
  - pymdownx.tasklist
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  - toc:
      permalink: true
  - pymdownx.arithmatex


extension_configs:
  pymdownx.highlight:
    anchor_linenums: true
    line_spans: __span
    pygments_lang_class: true
  pymdownx.tasklist:
    custom_checkbox: true
    clickable_checkbox: true
  pymdownx.emoji:
    emoji_index: !!python/name:material.extensions.emoji.twemoji
    emoji_generator: !!python/name:material.extensions.emoji.to_svg