No description
Find a file
2022-06-16 17:19:53 -04:00
.github/workflows Always update awesome-circuitpython during build 2022-05-28 20:37:48 +02:00
_blinka Fix Non-standard feature 2022-06-02 13:33:17 -04:00
_board Merge branch 'main' into master 2022-06-15 11:05:48 +01:00
_data fix download counts 2022-06-09 15:13:56 -04:00
_includes list frozen modules in the board download page 2022-05-11 14:41:04 +02:00
_layouts Move 'contributing' section into template 2022-01-03 20:43:23 -06:00
adabot@77089dab59 Updated adabot 2022-06-16 17:19:53 -04:00
assets Merge branch 'main' into master 2022-06-15 11:05:48 +01:00
awesome-circuitpython@e05e9e9ef0 Always update awesome-circuitpython during build 2022-05-28 20:37:48 +02:00
connect new common layout for pages, add common layout to connect page to update styling 2021-12-01 09:52:50 -06:00
contributing Fix contribution sort by issue tag bug 2022-06-09 09:32:06 -07:00
doc latest updates for master to main 2021-12-07 13:47:16 -06:00
lib/tasks rebase with upstream master, process new images 2019-06-05 14:06:29 -05:00
libraries Remove 6.x bundle links; add pointer to obsolete bundles list 2021-12-14 10:32:58 -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 autofocus downloads search and exclude .idea directory 2022-06-04 11:56:18 -05:00
awesome.html new common layout for pages, add common layout to connect page to update styling 2021-12-01 09:52:50 -06:00
blinka.html fix display of blinka page filters - make downloads.js happy 2021-09-21 17:38:46 -04:00
check-boards.py Added additional checks for boards and images 2022-05-26 14:12:06 -07:00
check-images.py Added additional checks for boards and images 2022-05-26 14:12:06 -07:00
CNAME Create CNAME 2019-03-08 19:53:06 -08:00
downloads.html Fix missing board and display the board id in place of 'Unknwon Board' 2022-02-21 09:13:34 -08: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 Bump image_processing from 1.12.1 to 1.12.2 2022-03-01 23:22:05 +00: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 Xiao / QTPy form factor feature 2022-05-12 07:43:42 -05: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