Skip to content
CircuitPython's website
HTML JavaScript CSS Ruby
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github/workflows
_blinka
_board
_data Automated website update for release 5.0.0-alpha.5 by Blinka. Nov 4, 2019
_includes initial move of contributing to root Oct 21, 2019
_layouts initial move of contributing to root Oct 21, 2019
adabot @ 56ccf2c
assets Add board file and images for Winterbloom Sol Nov 8, 2019
awesome-circuitpython @ fb372b9
contributing initial move of contributing to root Oct 21, 2019
lib/tasks
libraries
.gitignore .gitignore: Ignore files generated by bundle Sep 18, 2019
.gitmodules add adabot as a submodule for CI usage Apr 26, 2019
.travis.yml travis.yml: change libraries.json filename for transistion to new format Oct 11, 2019
404.html initial commit Nov 7, 2018
CNAME Create CNAME Mar 9, 2019
Gemfile
Gemfile.lock redirect old contributing page to new location Oct 21, 2019
README.md
Rakefile
_config.yml redirect old contributing page to new location Oct 21, 2019
awesome.html use common layout for grid Apr 4, 2019
blinka.html blinka to use the board_image include Jun 5, 2019
downloads.html fallback to original image if smaller images do not exist Jun 5, 2019
index.html use h2 for landing page header sections May 22, 2019
stats.html
template.md load images based on srcset and display smallest images possible for … Jun 4, 2019
trademarks.html Create trademarks.html Apr 15, 2019

README.md

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 install --path vendor/bundle
  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
You can’t perform that action at this time.