com2009

Content for the COM2009 ROS lab course site

Contributing

Setting up a Python Environment

Site is built using Material for MKDocs

First, create a Python virtual environment (ideally 3.9 or higher):

python -m venv venv

Activate the environment and install the latest version of Material for MKDocs:

pip install mkdocs-material

The MKDocs Awesome Pages Plugin:

pip install mkdocs-awesome-pages-plugin

And the Git Revision Date Localised Plugin:

pip install mkdocs-git-revision-date-localized-plugin

Editing

Site content is located in the "docs" directory. See here for guidance on how to write site content:

• General Guidance on Writing in Markdown: A Markdown Cheatsheet
• Material for MkDocs Documentation: https://squidfunk.github.io/mkdocs-material/reference/

To preview the site as you write use the following command (make sure the Python environment is active!):

mkdocs serve

Then go to http://localhost:8000/com2009/ in a browser.