BLine-Docs/mkdocs.yml at main · edanliahovetsky/BLine-Docs · 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
site_name: BLine Documentation
site_description: Open-source path generation and tracking suite for FRC holonomic drivetrains
site_url: https://edanliahovetsky.github.io/BLine-Docs/

theme:
  name: material
  custom_dir: overrides
  highlightjs: true
  hljs_languages:
    - java
    - json
    - yaml
    - bash
  palette:
    - scheme: slate
      primary: deep orange
      accent: blue
      toggle:
        icon: material/brightness-4
        name: Switch to light mode
    - scheme: default
      primary: deep orange
      accent: blue
      toggle:
        icon: material/brightness-7
        name: Switch to dark mode
  features:
    - navigation.instant
    - navigation.tracking
    - navigation.sections
    - navigation.expand
    - navigation.top
    - navigation.sidebar.sticky
    - search.suggest
    - search.highlight
    - content.code.copy
  icon:
    repo: fontawesome/brands/github

extra:
  social:
    - icon: fontawesome/solid/comments
      link: https://www.chiefdelphi.com/t/introducing-bline-a-new-rapid-polyline-autonomous-path-planning-suite/509778
      name: Chief Delphi Discussion
    - icon: fontawesome/brands/github
      link: https://github.com/edanliahovetsky/BLine-Lib
      name: BLine-Lib (GitHub)
    - icon: fontawesome/brands/github
      link: https://github.com/edanliahovetsky/BLine-GUI
      name: BLine-GUI (GitHub)

extra_css:
  - stylesheets/extra.css

extra_javascript:
  - javascripts/gif-lazy-load.js

markdown_extensions:
  - pymdownx.inlinehilite
  - pymdownx.snippets
  - pymdownx.superfences
  - pymdownx.tabbed:
      alternate_style: true
  - admonition
  - pymdownx.details
  - attr_list
  - md_in_html
  - tables
  - toc:
      permalink: true

plugins:
  - search
  - with-pdf:
      output_path: BLine-Docs.pdf
      cover_title: BLine Documentation
      cover_subtitle: Open-source path generation and tracking suite for FRC holonomic drivetrains
      enabled_if_env: ENABLE_PDF_EXPORT

nav:
  - Home: index.md
  - Getting Started:
    - Installation: getting-started/installation.md
    - Quick Start: getting-started/quick-start.md
  - Concepts:
    - Path Elements: concepts/path-elements.md
    - Constraints: concepts/constraints.md
    - Event Triggers: concepts/event-triggers.md
    - Key Parameters: concepts/key-parameters.md
    - Design Philosophy: concepts/design-philosophy.md
  - GUI:
    - Overview: gui/index.md
    - Menu Bar: gui/menu-bar.md
    - Canvas: gui/canvas.md
    - Sidebar: gui/sidebar.md
    - Simulation: gui/simulation.md
    - Protrusions: gui/protrusions.md
  - Library:
    - Overview: lib/index.md
    - Path Construction: lib/path-construction.md
    - FollowPath Builder: lib/follow-path.md
    - Event Triggers: lib/event-triggers.md
    - Alliance Flip & Mirror: lib/flip-and-mirror.md
    - Pre-Match Module Orientation: lib/pre-match.md
    - Logging: lib/logging.md
    - API Reference: lib/api-reference.md
  - Tuning & Usage Tips: usage-tips.md
  - Common Issues: common-issues.md