Skip to content

Getting Started

This guide will help you set up your development environment to participate in the Package Your Code workshop. Follow the steps below to ensure you can dive into the workshop content smoothly.

Fork the Repository

  1. Navigate to the Package Your Code Workshop GitHub repository
  2. Click the "Fork" button in the top-right corner to create a copy of the repository under your GitHub account.
  3. Click "Create fork" to confirm.

Open in GitHub Codespaces

  1. In your forked repository, click the green "Code" button.
  2. Select the "Codespaces" tab.
  3. Click "Create codespace on main" to launch a new Codespace instance. This may take a few moments to set up.
  4. Once the Codespace is ready, you will be taken to a VS Code environment in your browser. The repository will be cloned, and the development environment will be configured automatically, give it a few moments to finish setting up.

Fire Up the MkDocs Server

  1. Open a new terminal in the Codespace (Terminal > New Terminal).
  2. Run the following command to start the MkDocs development server: mkdocs serve
  3. Once the server is running, you will see a message indicating that the site is being served at a URL. Click on the URL to open the documentation in a new browser tab. This will update automatically as you make changes to the documentation files (which will happen in the MKDocs section of the workshop).

Stop the server

To stop the MkDocs server, return to the terminal where it's running and press Ctrl + C.

Find your first workshop

Head over to the workshops section of the website to get started with the workshop content.