-
Notifications
You must be signed in to change notification settings - Fork 46
/
mkdocs.yml
113 lines (106 loc) · 3.3 KB
/
mkdocs.yml
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
# Project information
site_name: Choreo Documentation
site_url: https://sleipnirgroup.github.io/Choreo/
site_description: A graphical tool for planning time-optimized trajectories for autonomous mobile robots in the FIRST Robotics Competition.
# Repository
repo_name: SleipnirGroup/Choreo
repo_url: https://github.com/SleipnirGroup/Choreo/
# Configuration
theme:
name: material
palette:
- media: "(prefers-color-scheme)"
toggle:
icon: material/link
name: Switch to light mode
- media: "(prefers-color-scheme: light)"
scheme: default
primary: deep purple
accent: indigo
toggle:
icon: material/toggle-switch
name: Switch to dark mode
- media: "(prefers-color-scheme: dark)"
scheme: slate
primary: black
accent: indigo
toggle:
icon: material/toggle-switch-off
name: Switch to system preference
font:
text: Roboto
code: Roboto Mono
logo: media/icon1024x1024.png
favicon: media/icon1024x1024.png
features:
- content.code.copy
- content.code.select
- content.code.annotate
- content.code.select.title
- toc.follow
- toc.integrate
- content.tabs.link
- search.share
- search.highlight
- search.suggest
- announce.dismiss
- navigation.tabs
- navigation.tabs.sticky
- navigation.top
- navigation.instant
# Extensions
markdown_extensions:
- admonition
- attr_list
- def_list
- md_in_html
- pymdownx.arithmatex:
generic: true
- pymdownx.details
- pymdownx.emoji:
emoji_index: !!python/name:material.extensions.emoji.twemoji
emoji_generator:
!!python/name:material.extensions.emoji.to_svg # Page tree
- pymdownx.highlight:
anchor_linenums: true
line_spans: __span
pygments_lang_class: true
- pymdownx.inlinehilite
- pymdownx.snippets
- pymdownx.superfences
- pymdownx.tabbed:
alternate_style: true
slugify: !!python/object/apply:pymdownx.slugs.slugify
kwds:
case: lower
extra_javascript:
- js/mathjax.js
- https://polyfill.io/v3/polyfill.min.js?features=es6
- https://cdn.jsdelivr.net/npm/mathjax@3/es5/tex-mml-chtml.js
nav:
- Home:
- Home: index.md
- Installation: installation.md
- Document Settings Panel: document-settings.md
- Robot Configuration: document-settings/robot-configuration.md
- File Export Settings: document-settings/file-export-settings.md
- Usage:
- Editing Paths: usage/editing-paths.md
- Controls & Shortcuts: usage/controls-shortcuts.md
- Saving: usage/saving.md
- View Options Panel: usage/view-options-panel.md
- Estimating Moment of Inertia: usage/estimating-moi.md
- ChoreoLib:
- Installation: choreolib/installation.md
- Getting Started: choreolib/basic-usage.md
- Auto Factory: choreolib/auto-factory.md
- Auto Routines: choreolib/auto-routines.md
- Auto Controller: choreolib/auto-controller.md
- Java API: api/choreolib/java/index.html
- C++ API: api/choreolib/cpp/index.html
- TrajoptLib (Internal API):
- C++ API: api/trajoptlib/cpp/index.html
- Contributing:
- Building: contributing/building-choreo.md
- Contributing Guide: contributing/contributing-guide.md
- Release Process: contributing/release-process.md