To test the changes locally, you before creating a Pull Request, you can run a copy of the the circuitpython.org website locally to see what everything looks like.

1. Open up a terminal or command prompt window.

2. You need "ruby" and "ruby-bundler" installed locally.

3. As needed, git submodule update --init --recursive to fetch the submodules.

4. One time, run bundle config set path 'vendor/bundle' && bundle install.

5. Run bundle exec jekyll serve 2>&1 to generate the site locally. The 2>&1 is optional and just suppresses a bunch of warning messages.

6. Visit the displayed server address in a browser.

After most local edits, the content will be updated. You will need to reload (ctrl-r/command-r or F5) your browser

This guide was first published on Jul 24, 2019. It was last updated on Jul 24, 2019.
This page (Testing Changes Locally) was last updated on Sep 28, 2020.