broncobots-docs

A repository containing all public-facing documentation for FRC Team 1987 Broncobots.

Installing

It is recommended to use a Python Virtual Environment (venv). If using VSCode, then follow this guide.

If you have Docker and VSCode installed, then feel free to use the development container.

pip install -r requirements.txt

Commands

• mkdocs new [dir-name] - Create a new project.
• mkdocs serve - Start the live-reloading docs server.
• mkdocs build - Build the documentation site.
• mkdocs -h - Print help message and exit.

Project layout

  mkdocs.yml    # The configuration file.
  docs/
      index.md  # The documentation homepage.
      ...       # Other markdown pages, images and other files.