Skip to content

Contributing to 401 Docs

This site uses Material for MkDocs, visit their docs to see what customization options are available. The uv package manager is used to handle python packages and virtual environments.

Running 401 Docs Locally

  1. Install uv
    uv provides a standalone installer to download and install uv:

    Use curl to download the script and execute it with sh:

    curl -LsSf https://astral.sh/uv/install.sh | sh

    If your system doesn't have curl, you can use wget:

    wget -qO- https://astral.sh/uv/install.sh | sh

    Use irm to download the script and execute it with iex:

    powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

    Changing the execution policy allows running a script from the internet.

Information on other installation methods (PyPi, Homebrew, WinGet, Scoop, etc.) is available in the uv install docs.

2. Clone this repo: 

git clone https://github.com/team401/Docs
3. Install Material for MkDocs and its dependencies: 
uv sync
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.
  • UV Toolkit adds uv features to the vscode command palette and adds highlighting.