No description
Find a file
2019-12-11 11:53:47 -08:00
.github/workflows rename build file, add image compression workflow 2019-10-23 14:46:09 -05:00
_blinka Adding LOTS of supported Blinka boards 2019-12-03 13:46:40 -08:00
_board Updated PyPortal Titano with new photos and info 2019-12-11 11:53:47 -08:00
_data Automated website update for release 5.0.0-beta.1 by Blinka. 2019-12-10 14:19:26 -08:00
_includes initial move of contributing to root 2019-10-21 16:10:26 -05:00
_layouts initial move of contributing to root 2019-10-21 16:10:26 -05:00
adabot@56ccf2c533 update adabot to pull in the changes to check for GitHub Actions migration 2019-10-31 17:50:16 -05:00
assets Updated PyPortal Titano with new photos and info 2019-12-11 11:53:47 -08:00
awesome-circuitpython@fb372b9804 update adabot and awesome-circuitpython submodules 2019-05-13 18:05:33 -05:00
contributing initial move of contributing to root 2019-10-21 16:10:26 -05:00
lib/tasks rebase with upstream master, process new images 2019-06-05 14:06:29 -05:00
libraries redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
.gitignore .gitignore: Ignore files generated by bundle 2019-09-17 20:36:47 -05:00
.gitmodules add adabot as a submodule for CI usage 2019-04-26 14:58:59 -05:00
.travis.yml travis.yml: change libraries.json filename for transistion to new format 2019-10-11 14:41:40 -05:00
404.html initial commit 2018-11-07 12:04:04 -06:00
_config.yml redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
awesome.html use common layout for grid 2019-04-04 15:36:49 -05:00
blinka.html blinka to use the board_image include 2019-06-05 14:26:17 -05:00
CNAME Create CNAME 2019-03-08 19:53:06 -08:00
downloads.html fallback to original image if smaller images do not exist 2019-06-05 12:57:15 -05:00
Gemfile redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
Gemfile.lock redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
index.html use h2 for landing page header sections 2019-05-22 11:47:07 -05: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 Docs: Explain how to test locally 2019-09-17 20:36:36 -05:00
stats.html add title and permalink 2019-04-04 15:39:20 -05:00
template.md load images based on srcset and display smallest images possible for each viewport size 2019-06-04 12:05:55 -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 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