No description
Find a file
2020-03-31 13:24:11 -07: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 Updated Beaglebone Black Wireless Manufacturer 2020-03-25 20:10:13 -07:00
_board Added Date Sorting for Downloads 2020-03-31 13:24:11 -07:00
_data Add download counts 2020-03-26 12:49:39 -07:00
_includes Updated blinka details page to only show instruction when available 2020-03-31 08:45:56 -07:00
_layouts Merge pull request #363 from jwcooper/new-design 2020-01-14 11:17:17 -08:00
adabot@cb47e0851d update adabot: includes list_repo() fix for forks, and pylint version validator 2020-03-18 15:15:59 -05:00
assets Added Date Sorting for Downloads 2020-03-31 13:24:11 -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 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
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 board counter for Blinka page 2019-12-30 13:05:43 -08: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
Gemfile redirect old contributing page to new location 2019-10-21 16:18:11 -05:00
Gemfile.lock Bump rake from 12.3.2 to 12.3.3 2020-02-29 17:27:27 +00: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 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 clarify the features list 2020-01-17 10:28:06 -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