FRC-Java-Tutorial/mkdocs.yml at main · RoboLancers/FRC-Java-Tutorial · 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
# Navigation
nav:
- Home:
  - 'index.md'
  - 'why_software.md'
- Setup:
  - 3rd_party_libs.md
- Version Control:
  - 'version_control/BasicGit.md'
  - 'version_control/GitWorkflow.md'
  - 'version_control/github.md'
- Programming Basics:
  - 'basics/roboRIO.md'
  - 'basics/sensors.md'
  - 'basics/wpilib.md'
  - 'basics/java_basics.md'
  - 'basics/ElectronicsCrashCourse.md'
  - 'basics/vscode_tips.md'
  # - 'basics/driverstation_tips.md'
- FRC Development Environment Setup:
  - 'setup/install_software.md'
  - 'setup/install_other.md'
  - 'setup/imaging_roboRIO.md'
- FRC Programming:
  - 'programming/new_project.md'
  - 'programming/driving_robot.md'
  - 'programming/deploying.md'
  - 'programming/using_sensors.md'
  - 'programming/pneumatics.md'
  - 'programming/Elastic.md'
  - 'programming/robotpreferences.md'
  - 'programming/autonomous.md'
  - 'programming/pid.md'
  - 'programming/AdvantageKit.md'
  - 'programming/AKitStructureReference.md'
  # - 'programming/super_core.md'
- Example Subsystems:
  - 'examples/basic_elevator.md'
  - 'examples/basic_shooter.md'
  - 'examples/pid_elevator.md'
  - 'examples/pid_shooter.md'

- Improve the Documentation:
  - 'contributing.md'

# Setup
site_name: FRC Java Programming
repo_name: Tutorial Bot
repo_url: https://github.com/RoboLancers/FRC-Java-Tutorial/tree/main
edit_uri: https://github.com/RoboLancers/FRC-Java-Tutorial/edit/main/docs/
site_author: Tayler Uva, Carl Stanton

# Theme
theme:
  name: 'material'
  favicon: assets/favicon.png
  #icon:
  #  logo: assets/favicon.png
  features:
    - content.tabs.link
    - content.code.copy
use_directory_urls: false

# Extensions
markdown_extensions:
  - admonition
  - pymdownx.critic
  - pymdownx.details
  - pymdownx.blocks.tab
  - pymdownx.betterem
  - pymdownx.tasklist
  - attr_list
  - pymdownx.inlinehilite
  - pymdownx.highlight:
      anchor_linenums: true
      line_spans: __span
      pygments_lang_class: true
  - pymdownx.superfences:
      custom_fences:
        - name: mermaid
          class: mermaid
          format: !!python/name:pymdownx.superfences.fence_code_format
  - pymdownx.snippets:
      base_path: ["."]
  - toc:
      permalink: "#"

# Plugins
plugins:
  - search
  # - minify:
  #     minify_html: true
  #     minify_js: true