A more detailed gude for adding a board to CircuitPython can be found in the following Adafruit Learn guide: How to add a New Board to the circuitpython.org website
To add a new board to the site:
- Duplicate
template.mdto_board/<board id>.md. - Edit
_board/<board id>.mdaccording to the template's instructions. - In your
_board/<board id>.mdyou will specify aboard_image. Create 3 versions of this file, in the following sizes and folder locations:
| Size | File | Dimensions (px) |
|---|---|---|
| Original | assets/images/orignal/{board_image} | 900px+ width and 4:3 ratio width |
| example: 900 x 675 | ||
| Large | assets/images/large/{board_image} | 800 x 600 |
| Small | assets/images/small/{board_image} | 300 x 225 |
For more information on preferred images or if you prefer or must use 13:10 see Preparing the Images in the Adafruit Learn guide
- Create a pull request with the file changes.
To test your changes locally:
- You need "ruby" and "ruby-bundler" installed locally. These instructions were tested with ruby 2.5 and ruby-bundler 1.17.3 on a Debian Stretch system.
- As needed,
git submodule update --init --recursiveto fetch the submodules - One time, run
bundle config set path 'vendor/bundle' && bundle install - Run
bundle exec jekyll serveto generate the site locally - Visit the displayed "server address"
- After most local edits, the content will be updated. You will need to reload (ctrl-r or F5) your browser