No description
Find a file
Kattni b83d40b603
Merge pull request #504 from kattni/6x-bundle
Drop 4.x bundle, add 6.x bundle.
2020-07-15 12:46:44 -04:00
.github/workflows adabot_cron.yml: adjust the scheduled time to be earlier; now 45 minutes before the Jekyll build 2020-03-19 10:11:40 -05:00
_blinka Added Odroid XU4 and XU4Q boards 2020-05-29 08:18:21 -07:00
_board Added images for UE Feather S2 2020-07-14 08:38:28 -07:00
_data Add download counts and reformat 2020-07-13 17:13:16 -07:00
_includes add lists of built-in modules supported for each board and release 2020-06-29 00:33:57 -05:00
_layouts Created initial RSS feed 2020-04-01 10:22:42 -07:00
adabot@ddcf3f05c0 update adabot: ignore various validators when setup.py.disabled exists 2020-04-18 08:50:08 -05:00
assets Added images for UE Feather S2 2020-07-14 08:38:28 -07:00
awesome-circuitpython@57c2bc9993 update awesome-circuitpython 2020-02-28 13:19:36 -06:00
contributing initial move of contributing to root 2019-10-21 16:10:26 -05: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 Drop 4.x bundle, add 6.x bundle. 2020-07-15 12:43:40 -04:00
.gitignore restore Gemfile.lock 2020-04-08 13:29:01 -04:00
.gitmodules add adabot as a submodule for CI usage 2019-04-26 14:58:59 -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 Added Date Sorting for Blinka boards 2020-03-31 14:37:04 -07:00
CNAME Create CNAME 2019-03-08 19:53:06 -08:00
downloads.html Added Date Sorting for Downloads 2020-03-31 13:24:11 -07:00
feed.html Added RSS Icon + Added image to items 2020-04-03 17:09:10 -07:00
Gemfile redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
Gemfile.lock restore Gemfile.lock 2020-04-08 13:29:01 -04:00
index.html move hero images to their own folder, and add config for setting the hero 2020-02-05 11:21:51 -06: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 Change on README, --path is being deprecated on bundle 2020-06-26 19:08:56 -06:00
stats.html add title and permalink 2019-04-04 15:39:20 -05:00
template.md Added Date to template.md 2020-03-31 18:35:59 -07: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