No description
Find a file
2021-11-30 11:13:42 -08:00
.github/workflows Don't deploy from a pull_request build 2021-11-30 11:13:42 -08:00
_blinka Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
_board Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
_data Remove adafruit_feather_esp32s2_nopsram which is not in CP 2021-11-15 18:49:26 -08:00
_includes support ru (Russian) downloads 2021-11-16 15:35:31 -05:00
_layouts [a11y] Small updates to header: skip links, navigation color contrast & aria-labels 2020-10-21 21:22:08 -04:00
adabot@61b0168901 Updated adabot submodule 2021-10-25 15:18:30 -04:00
assets Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
awesome-circuitpython@8ec68729b0 Updating submodules. 2021-04-20 12:29:47 -04:00
contributing Update Localization title and copy. 2020-07-24 16:06:03 -04:00
doc Fixed two typos 2020-02-06 14:27:45 -05:00
lib/tasks rebase with upstream master, process new images 2019-06-05 14:06:29 -05:00
libraries Update libraries/index.html 2021-11-02 12:04:13 -05:00
.gitignore Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
.gitmodules add adabot as a submodule for CI usage 2019-04-26 14:58:59 -05:00
.tool-versions use ruby 2.7.2 as default local version 2021-11-02 10:05:00 -05:00
404.html initial commit 2018-11-07 12:04:04 -06:00
_config.yml move hero images to their own folder, and add config for setting the hero 2020-02-05 11:21:51 -06:00
awesome.html use common layout for grid 2019-04-04 15:36:49 -05:00
blinka.html fix display of blinka page filters - make downloads.js happy 2021-09-21 17:38:46 -04:00
CNAME Create CNAME 2019-03-08 19:53:06 -08:00
downloads.html add fix for boards not in _data/files.json & mcu family entry stragglers 2021-09-21 15:45:40 -04:00
feed.html Added RSS Icon + Added image to items 2020-04-03 17:09:10 -07:00
Gemfile Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
Gemfile.lock Update to Ruby 3 and add RPI CP boards 2021-11-29 18:54:06 -08:00
index.html Update index.html 2021-04-25 20:37:26 -04:00
Rakefile load images based on srcset and display smallest images possible for each viewport size 2019-06-04 12:05:55 -05:00
README.md fix readme code formatting 2020-11-05 21:33:22 -06:00
stats.html add title and permalink 2019-04-04 15:39:20 -05:00
template.md Add Breadboard-Friendly and Arduino Shield Compatible. Other feature corrections. 2021-07-30 17:32:56 -04:00
trademarks.html Create trademarks.html 2019-04-15 14:49:33 -04:00

CircuitPython organization site

To add a new board to the site:

  1. Duplicate template.md to _board/<board id>.md.
  2. Edit _board/<board id>.md according to the template's instructions.
  3. Provide 3 images. An original high-quality image. A smaller image (300 px width), and a larger image (700 px width) in each respective directory (assets/images/boards/{small large original}) and process them in something like https://squoosh.app/ to reduce file size. If you only have one image, place it in the 'original' folder.
  4. Create a pull request with the file changes.

To test your changes locally:

  1. 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.
  2. As needed, git submodule update --init --recursive to fetch the submodules
  3. One time, run bundle config set path 'vendor/bundle' && bundle install
  4. Run bundle exec jekyll serve to generate the site locally
  5. Visit the displayed "server address"
  6. After most local edits, the content will be updated. You will need to reload (ctrl-r or F5) your browser