TinyMPC.github.io/mkdocs.yml at main · A2R-Lab/TinyMPC.github.io · 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
130
131
site_name: TinyMPC

repo_url: https://github.com/TinyMPC/TinyMPC
repo_name: TinyMPC

nav:
  - index.md
  - Get Started:
    - Installation: get-started/installation.md
    - Examples: get-started/examples.md
    - Obtaining the model: get-started/model.md
  - The Solver:
    - Inside TinyMPC: solver/solver.md
    - Background: solver/background.md

theme:
  name: material

  icon:
    logo: fontawesome/solid/microchip
    repo: fontawesome/brands/github
    annotation: material/arrow-right-circle

  favicon: media/favicon.ico

  palette:
    # Palette toggle for automatic mode
    - media: "(prefers-color-scheme)"
      toggle:
        icon: material/brightness-auto
        name: Switch to light mode

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

    # Palette toggle for dark mode
    - media: "(prefers-color-scheme: dark)"
      # scheme: tinympc-slate
      scheme: slate
      toggle:
        icon: material/weather-night
        name: Switch to system preference
      # primary: custom
      # primary: tinympc-slate

  features:
    # - navigation.instant # Using navigation.instant disables table of contents auto-highlighting
    # - navigation.instant.prefetch
    # - navigation.instant.progress
    # - navigation.tracking
    - navigation.tabs
    - navigation.sections
    # - navigation.path # Insiders feature
    # - navigation.indexes # Incompatible with toc.integrate
    - navigation.footer
    - navigation.top

    - toc.follow
    - toc.integrate

    - search.suggest
    - search.share

    # - header.autohide

    - content.code.copy
    # - content.code.select # Insiders feature
    - content.code.annotate
    - content.tabs.link

plugins:
  - search
  # - git-revision-date-localized:
  #     enable_creation_date: true
  #     type: date

extra:
  social:
    - icon: fontawesome/brands/youtube
      link: https://www.youtube.com/watch?v=NKOrRyhcr6w
      name: TinyMPC on YouTube
    - icon: fontawesome/brands/github
      link: https://github.com/TinyMPC
      name: TinyMPC on GitHub
    - icon: simple/arxiv
      link: https://arxiv.org/abs/2310.16985
      name: TinyMPC on arXiv

markdown_extensions:
  - attr_list
  - md_in_html
  - pymdownx.emoji:
      emoji_index: !!python/name:material.extensions.emoji.twemoji
      emoji_generator: !!python/name:material.extensions.emoji.to_svg
  # Code blocks
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.details
  - pymdownx.tabbed:
      alternate_style: true
  - pymdownx.arithmatex:
      generic: true
  # Admonitions
  - admonition
  # Formatting
  - pymdownx.critic
  - pymdownx.caret
  - pymdownx.keys
  - pymdownx.mark
  - pymdownx.tilde

extra_javascript:
  - javascript/mathjax.js
  - https://polyfill.io/v3/polyfill.min.js?features=es6
  - https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js

extra_css:
  - stylesheets/extra.css

copyright: Copyright &copy; 2024 Robotic Exploration Lab