For Linux-based Single Board Computers, you will want to add the new board to the Blinka section of the website.
Image Location
Once you have your images prepared, you will want to place them into the three folders inside assets/images/boards as follows:
- The Original Sized image should be placed into the original folder.
- The Larger of the two resized images should be placed into the large folder.
- The Smaller of the two resized images should be placed into the small folder.
All three images should have the same filename.
Markdown File
The markdown file contains all of the information used for the board. To create a Markdown file for the board, go into the _blinka folder and make a duplicate of one of the other files.
You will want to rename the duplicate to something like board_name.md to match your image files. For instance, if we're going to add the Raspberry Compute Module 3, we'll make a copy of raspberry_pi_3b.md because the board is the most similar to the board we're adding. We'll name it raspberry_pi_cm3.md and we'll makes sure all of the images are named raspberry_pi_cm3.jpg.
Open up the new markdown file in your favorite text editor. This should be a text editor like notepad and not a word processor such as Microsoft Word because word processors add extra data that will not work well with the Markdown file format.
We'll start with the header section and go line by line to make sure you have the correct information added. The header section always starts with three hyphen characters and ends with three hyphen characters. You can always look at the other Markdown files for examples too.
Here's the file that we're starting with.
--- layout: download board_id: "raspberry_pi_3bplus" title: "Raspberry Pi 3 Model B+ Download" name: "Raspberry Pi 3 Model B+" manufacturer: "Raspberry Pi Foundation" board_url: "https://www.raspberrypi.org/products/raspberry-pi-3-model-b-plus/" board_image: "raspberry_pi_3bplus.jpg" download_instructions: "https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi" downloads_display: true blinka: true date_added: 2019-6-17 features: - Wi-Fi - Bluetooth/BLE - Ethernet - HDMI/DisplayPort - 40-pin GPIO --- The Raspberry Pi 3 Model B+ is the most popular Raspberry Pi computer made, and the Pi Foundation knows you can always make a good thing better! And what could make the Pi 3 better? How about a faster processor, 5 GHz WiFi, and updated Ethernet chip with PoE capability? Good guess - that's exactly what they did! The Raspberry Pi 3 Model B+ is the latest product in the Raspberry Pi 3 range, boasting an updated 64-bit quad core processor running at 1.4GHz with built-in metal heatsink, dual-band 2.4GHz and 5GHz wireless LAN, faster (300 mbps) Ethernet, and PoE capability via a separate PoE HAT. - Broadcom BCM2837B0, Cortex-A53 (ARMv8) 64-bit SoC @ 1.4GHz - 1GB LPDDR2 SDRAM - 2.4GHz and 5GHz IEEE 802.11.b/g/n/ac wireless LAN, Bluetooth 4.2, BLE - Gigabit Ethernet over USB 2.0 (maximum throughput 300 Mbps) - Extended 40-pin GPIO header - Full-size HDMI - 4 USB 2.0 ports - CSI camera port for connecting a Raspberry Pi camera - DSI display port for connecting a Raspberry Pi touchscreen display - 4-pole stereo output and composite video port - Micro SD port for loading your operating system and storing data - 5V/2.5A DC power input - Power-over-Ethernet (PoE) support (requires separate PoE HAT) ## Purchase * [Adafruit](https://www.adafruit.com/product/3775) ## Contribute Have some info to add for this board? Edit the source for this page [here](https://github.com/adafruit/circuitpython-org/edit/master/_blinka/{{ page.board_id }}.md).
Header
Let's take a look at the Header Options. You may notice that there's a few more here than the downloads page has.
layout
Leave this set to download. Even though this is the Blinka page, the layout should be the same as the download page.
board_id
This should be the name of the board for example "raspberry_pi_cm3".
title
This is the page title and should be more descriptive and end with the word Download. For example "Raspberry Pi Compute Module 3 Download".
name
This is the name of the board and should be the same as Title but without the word Download. For example "Raspberry Pi Compute Module 3".
manufacturer
The name of the board manufacturer. For example "Raspberry Pi Foundation".
board_url
This is a full URL that the use to view the product information for the board. For example "https://www.raspberrypi.org/products/compute-module-3/".
board_image
This is the filename only for the image you created. The path for the appropriate sized will automatically be generated. For instance "raspberry_pi_cm3.jpg".
download_instructions
This should be the full URL that points to the appropriate setup guide. For example "https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi". Leave it blank if there are no board setup instructions.
downloads_display
This can optionally be included in order to hide your board by setting it to false. Omitting this value or setting it to true will display your board.
blinka
This value should always be set to true. This tells the downloads layout to look for the additional Blinka page header options.
date_added
This should be the date that the new board was merged in and released in Blinka. It should be in the format of YYYY-M-D
.
features
This is a list with features that the board has such as Battery Charging, Bluetooth, WiFi, etc. Items in this list are preceded by two spaces, a hyphen character, and another space. Features should be limited to the items in this list and spelled exactly the same:
- Ethernet
- HDMI/DisplayPort
- Wi-Fi
- 40-pin GPIO
- GPS
- Feather-Compatible
- Bluetooth/BLE
- STEMMA QT/QWIIC
- USB 3.0
- Infrared Receiver
Body
The body is more free form and should include at least one paragraph for a description of the board. This is often copied from a product page. If this is available on the vendor website, this would be the preferred text. If not, we usually make it concise, but informational.
Purchase Section
If a board is available for purchase, it should include a Purchase section with one or more links. The link text should be the name of the website it linked to such as Amazon, Adafruit, AliExpress, etc.
Learn More Section
This section is more commonly found on pages where the board is not yet available for purchase. This should include informational links about the board. The link text should be the name of the website it linked to such as GitHub, NVIDIA, etc.
Final File
After editing the duplicated file, this is what it looks like. In this case, it was not available on adafruit.com, but was available through the Raspberry Pi Foundation website.
--- layout: download board_id: "raspberry_pi_cm3" title: "Raspberry Pi Compute Module 3 Download" name: "Raspberry Pi Compute Module 3" manufacturer: "Raspberry Pi Foundation" board_url: "https://www.raspberrypi.org/products/compute-module-3/" board_image: "raspberry_pi_cm3.jpg" download_instructions: "https://learn.adafruit.com/circuitpython-on-raspberrypi-linux/installing-circuitpython-on-raspberry-pi" downloads_display: true blinka: true date_added: 2019-6-24 features: - HDMI/DisplayPort --- The Compute Module 3 contains the guts of a Raspberry Pi 3 (the BCM2837 processor and 1GB RAM) as well as an optional 4GB eMMC Flash device (which is the equivalent of the SD card in the Pi). The Pi 3 has a processor speed of 1.2GHz and runs at roughly 10 times the speed of the Pi 1 due to its quad-core CPU. This is all integrated on to a small 67.6mm x 31mm board which fits into a standard DDR2 SODIMM connector (the same type of connector as used for laptop memory). The Flash memory is connected directly to the processor on the board, but the remaining processor interfaces are available to the user via the connector pins. You get the full flexibility of the BCM2837 SoC (which means that many more GPIOs and interfaces are available as compared to the Raspberry Pi), and designing the Module into a custom system should be relatively straightforward as we’ve put all the tricky bits onto the Module itself. The Compute Module is available for purchase in single units, or in batches of hundreds or thousands. To get started designing a PCB to use the Module, we provide an open-source breakout board with a single Module in an affordable development kit. ## Purchase * [Raspberry Pi Foundation](https://www.raspberrypi.org/products/compute-module-io-board-v3/)
Page last edited March 08, 2024
Text editor powered by tinymce.