Skip to content

Contributing to 401 Docs

Testing and Running Locally

This site uses Material for MkDocs, visit their docs to see what customization options are available.

  1. Clone this repo by running: git clone https://github.com/team401/Docs

  2. Optionally, to avoid installing the Python packages into your user account, create a virtual environment first:

1
python -m venv venv

You must activate the environment every time you wish to use it:

1
source venv/bin/activate   # on Unix/Linux/macOS

1
2
venv\Scripts\activate      # on Windows, command prompt
venv\Scripts\Activate.ps1  # on Windows, PowerShell

where venv is a name and directory location you can choose. If you don't set up and activate a virtual environment first, pip will install MkDocs into your personal account.

3 Then install Material for MkDocs and its dependencies: pip install -r requirements.txt

4 Serve the site locally: mkdocs serve

Project layout

mkdocs.yml    # The configuration file.
docs/
    index.md  # The documentation homepage.
    programming/
        index.md # Programming section homepage
        ... # Other programming files
    ... # Other markdown pages, images and other files.
  • markdownlint automatically checks for style errors in markdown files.