mirror of
https://github.com/odriverobotics/ODrive.git
synced 2026-08-18 09:29:03 +08:00
Samuel Sadok
426236dff1
This adds a jinja template to generate markdown files (with lots of HTML mixed in) from YAML using the existing interface_generator.py script. The docs website layout files are modified to incorporate the new documentation. While previously Github Pages was automatically running Jekyll on the docs folder, this commit adds a custom Github workflow to compile and deploy the website to facilitate the custom markdown generation step before Jekyll runs.
43 lines
1.3 KiB
YAML
43 lines
1.3 KiB
YAML
|
|
# This data could theoretically be retrieved directly from the md files:
|
|
# https://jekyllrb.com/tutorials/navigation/#scenario-8-retrieving-items-based-on-front-matter-properties
|
|
|
|
sections:
|
|
- title: General
|
|
docs:
|
|
- title: Getting Started
|
|
url: /
|
|
- title: ODrive Tool
|
|
url: /odrivetool
|
|
- title: Parameters & Commands
|
|
url: /commands
|
|
- title: Interfaces
|
|
url: /interfaces
|
|
- title: Encoders
|
|
url: /encoders
|
|
- title: Homing & Endstops
|
|
url: /endstops
|
|
- title: Control & Tuning
|
|
url: /control
|
|
- title: Troubleshooting
|
|
url: /troubleshooting
|
|
- title: Tutorials
|
|
docs:
|
|
- title: Hoverboard Guide
|
|
url: /hoverboard
|
|
- title: API Reference
|
|
- title: For ODrive Developers
|
|
docs:
|
|
- title: Firmware Developer Guide
|
|
url: /developer-guide
|
|
- title: Configuring Visual Studio Code
|
|
url: /configuring-vscode
|
|
- title: Configuring Eclipse
|
|
url: /configuring-eclipse
|
|
- title: Component Guides
|
|
docs:
|
|
- title: Motor Guide
|
|
url: https://docs.google.com/spreadsheets/d/12vzz7XVEK6YNIOqH0jAz51F5VUpc-lJEs3mmkWP1H4Y
|
|
- title: Encoder Guide
|
|
url: https://docs.google.com/spreadsheets/d/1OBDwYrBb5zUPZLrhL98ezZbg94tUsZcdTuwiVNgVqpU
|