No description
Find a file
2021-03-12 14:49:56 -03:00
.github/workflows Fix dependency issue 2021-01-25 08:30:30 -08:00
_blinka Added new Blinka boards 2021-02-26 13:18:46 -08:00
_board Removed extra new line at end of file 2021-02-24 17:01:51 +00:00
_data download counts 2021-03-03 21:22:20 -05:00
_includes Merge branch 'more_blinka' of https://github.com/tannewt/circuitpython-org into prtest 2021-01-06 16:42:54 -08:00
_layouts Update Localization title and copy. 2020-07-24 16:06:03 -04:00
adabot@d22437b175 Update submodule. 2020-11-25 13:29:45 -05:00
assets Adding franzininho wifi boards images 2021-03-12 14:49:56 -03:00
awesome-circuitpython@57c2bc9993 update awesome-circuitpython 2020-02-28 13:19:36 -06:00
contributing Update Localization title and copy. 2020-07-24 16:06:03 -04: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 remove 5.x bundle boilerpalte 2021-01-31 15:12:41 -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 more blinka boards plus other updates 2021-01-21 12:14:59 -08:00
CNAME Create CNAME 2019-03-08 19:53:06 -08:00
downloads.html Remove file urls from files.json 2020-11-17 17:08:06 -08:00
feed.html Added RSS Icon + Added image to items 2020-04-03 17:09:10 -07:00
Gemfile add json gem into jekyll_plugins group 2020-08-10 11:03:16 -05:00
Gemfile.lock Revert github pages dependency changes 2021-01-25 08:42:37 -08:00
index.html Swapped out images on index 2021-01-08 08:42:29 -08: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 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