Skip to main content

Setting up enviorment for Middleman

Prerequisites​

Installing Visual Studio Code​

Visual Studio Code (VSCode) is a powerful, lightweight code editor that provides an excellent development experience. Follow the instructions below based on your operating system:

Windows​

  1. Download the VSCode installer from the official website
  2. Run the installer and follow the installation wizard
  3. Alternative installation via Command Prompt (requires Chocolatey): 
    choco install vscode

macOS​

  1. Download the .dmg file from the VSCode website
  2. Open the downloaded file and drag VSCode to your Applications folder
  3. Alternative installation via Homebrew: 
    brew install --cask visual-studio-code

Linux (Ubuntu/Debian)​

# Download and install the .deb package
wget -qO- https://packages.microsoft.com/keys/microsoft.asc | gpg --dearmor > packages.microsoft.gpg
sudo install -D -o root -g root -m 644 packages.microsoft.gpg /etc/apt/keyrings/packages.microsoft.gpg
sudo sh -c 'echo "deb [arch=amd64 signed-by=/etc/apt/keyrings/packages.microsoft.gpg] https://packages.microsoft.com/repos/code stable main" > /etc/apt/sources.list.d/vscode.list'
rm -f packages.microsoft.gpg

sudo apt update
sudo apt install code

Installing Python Extensions​

VSCode Python Extension Installation​

  1. Open Visual Studio Code
  2. Click on the Extensions view icon on the sidebar (or press Ctrl+Shift+X)
  3. Search for "Python"
  4. Install the official Microsoft Python extension

Command Line Installation​

# For VSCode CLI extension installation
code --install-extension ms-python.python

Project Setup​

Clone the Repository​

  1. Open your terminal or command prompt
  2. Navigate to the directory where you want to set up your project
  3. Clone the repository: 
    # Define your base folder (replace $MIDDLEMAN_BASE_FOLDER$ with your desired path)
    mkdir -p $MIDDLEMAN_BASE_FOLDER$
    cd $MIDDLEMAN_BASE_FOLDER$

    # Clone the repository
    git clone https://github.com/TravellingLanguages/docs.git
    # to open the project in VSCode
    code .

Configuration Setup​

For detailed credential and environment configuration, please refer to the project-specific documentation:

👉 Middleman Configuration Guide

Troubleshooting​

Common Issues​

  • Ensure you have Git installed before cloning the repository
  • Check that you have the latest version of VSCode
  • Verify Python extension compatibility with your VSCode version

Pro Tip: Consider using a virtual environment for Python projects to manage dependencies effectively.