Skip to main content

Templates

Configuration Templates​

README Template​

# Board Name

![Image of Board](site/docs/assets/gp2040-ce-placeholder.png)

Basic description of the board

(RP2040 Pinout as a markdown table)
| GPIO Pin | Input/Function |
|:--------:|:--------------:|
| 0 | |
| 1 | |
| 2 | |
| 3 | |
| 4 | |
| 5 | |
| 6 | |
| 7 | |
| 8 | |
| 9 | |
| 10 | |
| 11 | |
| 12 | |
| 13 | |
| 14 | |
| 15 | |
| 16 | |
| 17 | |
| 18 | |
| 19 | |
| 20 | |
| 21 | |
| 22 | |
| 23 | |
| 24 | |
| 25 | |
| 26 | |
| 27 | |
| 28 | |
| 29 | |

Device Maintainer: [Name, Username, or Business Name](https://github.com/username)
Supported Hardware Variations: List versions/variations that share this configuration
Hardware Availability: List where one can purchase the boards that share this configuration

Documentation Templates​

Page Template​

---
title: TITLE
# tags:
# -
pagination_next: null
pagination_prev: null
description: "PAGE DESCRIPTION"
---

# Document Title

CONTENT

Add-On Template​

---
title: ADD-ON NAME
# tags:
# -
pagination_next: null
pagination_prev: null
description: "PAGE DESCRIPTION"
---

# Add-On Name

Purpose: The intended function and purpose of this add-on for an end user.

![Web Configurator Image](../assets/gp2040-ce-placeholder.png)

## Web Configurator Options

- Web Configurator Option 1
- Web Configurator Option 2
- Web Configurator Option 3

## Hardware

### Requirements

TODO: List any hardware that is required for the intended functioning of this add-on.

### Installation

TODO: List instructions on how to install the hardware for use with this add-on.

## Miscellaneous Notes

TODO: Provide any miscellaneous notes that an end user may want or need to know with regard to this add-on.

Downloads Page Configurations​

Microcontroller Boards​

{
    name: 'Microcontroller Board Name',
    configName: 'ConfigName',
    pinout: null,
    website: 'http://www.example.com/index.html',
    image: require('@site/docs/assets/gp2040-ce-placeholder.png').default,
    supported: true,
    desc: () => (
        <p>
            Description of Microcontroller board and manufacturer
        </p>
    ),
},

Controllers​

{
    name: 'Controller Name',
    configName: 'ConfigName',
    pinout: null,
    website: 'http://www.example.com/index.html',
    image: require('@site/docs/gp2040-ce-placeholder.png').default,
    category: 'official/open/closed/legacy',
    desc: () =>
        <p>
            Description of the device and maker.
        </p>,
},