How to Edit This Site

Our site uses separate frameworks for our main landing page and documentation site. pittsailbot.github.io is built using static HTML/JS/CSS and our documentation is built with mkdocs. This provides flexibility for our web-design and ease-of-use for writing documentation.

Why static and not React/Svelte/X framework? - Our site is not complicated - Pure html minimizes dependencies

Documentation is written in markdown and published through Github pages using mkdocs. If you're unfamiliar with using markdown, check out this handy cheat sheet.

In depth documentation for mkdocs can be found here.

Google Analytics for our site can also be viewed here

Install dependencies

In the terminal, install dependencies with:

pip install -r requirements.txt

Making changes

Our documentation is written in markdown and is organized into pages by mkdocs.yml. The main site is a combination of html and css.

For editing any pre-existing .md files, changes will be updated automatically
If you are adding any new files, then add the file under the mkdocs.yml's nav config like so:

nav:
   - Getting Started: "Getting Started.md"

This will make the file "Getting Started.md" visible on the web page's index

Previewing changes

To preview the documentation site before pushing changes to github:

In the terminal, run:

mkdocs serve

In any web browser navigate to 127.0.0.1:8000