• Stars
    star
    158
  • Rank 237,131 (Top 5 %)
  • Language
    Python
  • License
    Creative Commons ...
  • Created almost 3 years ago
  • Updated about 2 months ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Arduino documentation (docs.arduino.cc)

docs-content

What Is this Repository?

This repository hosts the content for Arduino's documentation website. The content needs to be written in Markdown and will be converted to HTML automatically during the build process.

The production website is available at: https://docs.arduino.cc

How Can I Contribute?

Contributing by creating content or suggesting changes to existing content can be done by making pull requests.

You start by forking the repository or by creating a new branch if you have write access to this repo. Create a new branch based on main and name it according to what you will create prefixed with your GitHub username and a slash (e.g. sebromero/wifi-tutorial). Read in the section below how to add different types of new content.

When you're done with a draft you can create a pull request. This will give the content team the possibility to review it and leave comments or request changes. During this review process, you can continue to push commits to the same branch. They will show up in the pull request automatically.

Once the pull request gets approved and merged into main, the content will be deployed to the live server.

Fixing Bugs and Typos

If you find a mistake in the content, you need to locate the corresponding file to fix it and create a pull request. Here is how to locate the content.

Products

  • If you have found an issue in a hardware product-specific tutorial they are located according to the following pattern: /content/hardware/[product-family]/[product-type]/[product]/tutorials/[tutorial-name]/[content-file].md

  • If you have found an issue in a hardware product's datasheet they are located according to the following pattern: /content/hardware/[product-family]/[product-type]/[product]/datasheet/datasheet.md

  • If you have found an issue in a hardware product's description they are located according to the following pattern: /content/hardware/[product-family]/[product-type]/[product]/product.md

  • If you have found an issue in a hardware product's tech specs table they are located according to the following pattern: /content/hardware/[product-family]/[product-type]/[product]/tech-specs.yml

  • If you have found an issue in a hardware product's features they are located according to the following pattern: /content/hardware/[product-family]/[product-type]/[product]/features.md

Software

  • If you have found an issue in a software product's tutorial they are located according to the following pattern: /content/software/[product-name]/tutorials/(tutorial-subfolder)/[tutorial-name]/[content-file].md

Adding Content

Referencing Content From Other Folders

The build system supports symlinks. This allows the inclusion of content in multiple places. For example, if there is a tutorial that works for different boards, it can be written once and included in different places. On Unix the ln command can be used for that.

For example, if we want a tutorial that lives here content/tutorials/generic/basic-servo-control to show up on the Nano 33 BLE product page, we can link it as follows. First, open a shell and navigate to the tutorials folder of the product. e.g. cd content/hardware/03.nano/boards/nano-33-ble/tutorials/. Then create a symlink with a relative path to the tutorial. e.g. ln -s ../../../../../tutorials/generic/basic-servo-control basic-servo-control. This will create a symbolic link to that directory without duplicating it. Any change can be made in either location. They will be applied to the source file in both cases.

Adding Symlinks on Windows

To create symlinks using Windows OS, follow the below steps:

  • Start a terminal (CMD) as admin.
  • Navigate to the folder you want the symlinks. For example, to create a link for the UNO board, navigate to docs.arduino.cc\content\hardware\02.hero\boards\uno-rev3\tutorials.
  • To create a symlink, you will need to run a command akin to:
mklink AnalogInput "..\..\..\..\..\built-in-examples\03.analog\AnalogInput"

The ..\..\ needs to match the location of the original file. Each ..\ is a step up the directory.

Note that when creating the symlink, you will not see a file in VS code, but when you commit changes it will be recognized.

On success, the following is printed:

symbolic link created for AnalogInput <<===>> ..\..\..\..\..\built-in-examples\03.analog\AnalogInput

Including Code Snippets

Code snippets can be included by using the triple backticks syntax e.g. ```arduino followed by the code and three closing backticks. The following syntaxes are supported:

arduino, bash, markup, clike, c, cpp, css, css-extras, javascript, jsx, js-extras, coffeescript, diff, git, go, graphql, handlebars, json, less, makefile, markdown, objectivec, ocaml, python, reason, sass, scss, sql, stylus, tsx, typescript, wasm, yaml

Including Code Blocks fetching GitHub pages

CodeBlocks are custom components that can be added directly in the Markdown on docs-content.

Using this component, the code block will be fetched directly from GitHub pages.

Syntax:

<CodeBlock url=โ€https://github.com/exampleโ€ className="{language}"/>

Broken URLs will show an error alert. URL must be in the GitHub domain and must be public.

Previewing Changes

Whenever you create a Pull Request (PR) GatsbyCloud will create a preview deployment in which you can see how your changes look when rendered on the website. The link to the preview will appear in the comments of the PR. This also works with Draft PRs, but not for PRs created from a fork.

License

Please note that your contribution to the Arduino Documentation is licensed under a Creative Commons Attribution-Share Alike 4.0 License. see https://creativecommons.org/licenses/by-sa/4.0/

More Repositories

1

Arduino

Arduino IDE 1.x
Java
14,104
star
2

arduino-cli

Arduino command line tool
Go
4,327
star
3

arduino-ide

Arduino IDE 2.x
TypeScript
2,230
star
4

ArduinoCore-avr

The Official Arduino AVR core
C
1,220
star
5

arduino-pro-ide

The Arduino IDE for advanced users and developers. Experimental alpha version.
884
star
6

ArduinoCore-samd

Arduino Core for SAMD21 CPU
C
463
star
7

arduino-builder

A command line tool for compiling Arduino sketches
Go
455
star
8

arduino-create-agent

The Arduino Create Agent
Go
415
star
9

ArduinoCore-mbed

C
345
star
10

ArduinoCore-arc32

C
327
star
11

ArduinoTensorFlowLiteTutorials

Jupyter Notebook
260
star
12

library-registry

Arduino Library Manager list
244
star
13

lab-micropython-editor

Arduino Lab for MicroPython is an Integrated Development Environment (IDE) for MicroPython.
JavaScript
220
star
14

ArduinoCore-API

Hardware independent layer of the Arduino cores defining the official API
C++
202
star
15

reference-en

Editable source for the Arduino Reference
165
star
16

openwrt-yun

A custom version of OpenWrt, targeted to the Arduino Yรบn
C
148
star
17

toolchain-avr

The AVR toolchain used by the Arduino IDE
Shell
142
star
18

arduino-language-server

An Arduino Language Server based on Clangd to Arduino code autocompletion
Go
136
star
19

nina-fw

Firmware for u-blox NINA W102 WiFi/BT module
C
135
star
20

setup-protoc

GitHub Action to setup the protoc compiler for protocol buffers
TypeScript
134
star
21

OpenOCD

Fork of OpenOCD
C
119
star
22

ArduinoCore-renesas

C
111
star
23

setup-task

GitHub Actions action to make Task available for use in your workflow
TypeScript
104
star
24

arduino-lint

Tool to check for problems with Arduino projects
Go
104
star
25

linino

C
103
star
26

ArduinoCore-megaavr

Arduino Core for the ATMEGA4809 CPU
C++
103
star
27

wifishield

Arduino Wifi Shield
C
92
star
28

arduino-examples

Arduino IDE bundled examples
Shell
92
star
29

ArduinoCore-nRF528x-mbedos

[Archived] Arduino core supporting mbed-enabled boards
C
86
star
30

ArduinoCore-sam

HTML
79
star
31

setup-arduino-cli

GitHub Action to setup Arduino CLI
TypeScript
76
star
32

YunBridge

Python
72
star
33

BtSerial

A Bluetooth Serial library for Processing for Android
Java
71
star
34

ArduinoAI

Arduino AI content / demos
JavaScript
71
star
35

ArduinoCloudProviderExamples

Examples of how to connect various Arduino boards to cloud providers.
C
71
star
36

tutorials

C++
70
star
37

openwrt-packages-yun

Makefile
66
star
38

compile-sketches

GitHub Actions action that checks whether Arduino sketches compile and produces a report of data from the compilations
Python
65
star
39

AIoT-Dev-Summit-2019

C++
56
star
40

RXTX

Arduino version of RXTX
Shell
55
star
41

arduino-fwuploader

A Command Line Tool made to update the firmware and/or add SSL certificates for any Arduino board equipped with WINC or NINA Wi-Fi module.
Go
52
star
42

YunWebUI

Arduino/Genuino Yรบn or Yรบn Shield Web panel
JavaScript
51
star
43

arduino-preprocessor

Parses an Arduino Sketch and converts it into valid C++ source code
C++
49
star
44

Arduino-Science-Journal-Android

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Java
48
star
45

nicla-sense-me-fw

Arduino Nicla Sense ME resources (libraries, bootloader, host pc utilities)
C
47
star
46

language

This repository serves a central entry point to discussions concerning the Arduino Language.
46
star
47

arduino-lint-action

GitHub Actions action to check Arduino projects for problems
TypeScript
44
star
48

go-apt-client

Go
41
star
49

summer-of-code

Arduino @ Google Summer of Code
40
star
50

ArduinoCore-primo

Arduino core for nrf52 cpu
C
39
star
51

arduino-iot-js

Arduino IoT Cloud - Javascript SDK
JavaScript
38
star
52

ArduinoISP

C
37
star
53

TFTP-Bootloader

An unfinished TFTP bootloader for Arduino Ethernet
C
37
star
54

EduIntro

Arduino library aimed at making super-fast introductory workshops to Arduino. Based on the idea of having components as objects in the code.
C++
37
star
55

arduino-connector

Connector to the Arduino Create Cloud and IoT platform
Go
36
star
56

avrdude-build-script

avrdude build scripts for Arduino/Genuino
Shell
34
star
57

actions

Collection of custom Github actions
Python
34
star
58

arduino-create-agent-js-client

JS module providing discovery of the Arduino Create Plugin and communication with it
JavaScript
33
star
59

arduino-iot-cloud-py

Arduino IoT Cloud Python Client.
Python
28
star
60

mcuboot-arduino-stm32h7

C
27
star
61

uno-r4-wifi-usb-bridge

C++
27
star
62

arduino-usb-scanner

Tool that scans the USB bus autodetecting Arduino boards and their serial port names
26
star
63

uno-r4-library-compatibility

25
star
64

arduinoOTA

Go
25
star
65

rp2040tools

Go
23
star
66

iot-client-py

Python client for Arduino IoT API
Python
23
star
67

astyle

Scripts and patches used to build astyle, a code formatter used by the Arduino IDE
Shell
23
star
68

vscode-arduino-tools

Arduino Language Server extension for VS Code
TypeScript
23
star
69

arduino-cli-example

C++
23
star
70

ArduinoModule-CMSIS-Atmel

Atmel Smart ARM devices CMSIS module for Arduino IDE
C
23
star
71

iot-client-js

Javascript client for Arduino IoT API
JavaScript
23
star
72

mkrwan1300-fw

C++
22
star
73

dfu-utils-cross

scripts to compile (and cross-compile from a Linux machine) dfu-utils package for Linux (x86_64, x86, arm), OSX and Windows.
C
22
star
74

Arduino-Science-Journal-iOS

Use the sensors in your mobile devices to perform science experiments. Science doesnโ€™t just happen in the classroom or labโ€”tools like Science Journal let you see how the world works with just your phone.
Swift
22
star
75

Tests

Arduino
21
star
76

arduino-flash-tools

Arduino Tools for Create
C
21
star
77

HMC5983

Proof of concept of an Arduino library for Honeywell's HMC5983 magnetic sensor.
C++
20
star
78

serial-discovery

An Arduino IDE pluggable-discovery for Serial ports
Go
19
star
79

ethernet-bootloader

TFTP Bootloader for the Arduino Ethernet Board
C
19
star
80

iot-client-go

Go client for Arduino IoT API
Go
19
star
81

mdns-discovery

mdns (bonjour) pluggable discovery
Go
18
star
82

arduino-cloud-cli

Go
16
star
83

lab-micropython-installer

This repository hosts the entire code of the Arduino MicroPython Installer tool
C
16
star
84

cpp-test-action

A GitHub Actions action for testing C/C++ projects
15
star
85

serial-monitor

Arduino pluggable monitor for serial ports
Go
15
star
86

ctags

A mix of ctags and anjuta-tags for the perfect C++ ctags
C
15
star
87

livecast

Code for the examples presented at the Arduino Livecasts
C++
15
star
88

report-size-deltas

GitHub Actions action that comments on pull requests with a report of change in memory usage of Arduino sketches
Python
14
star
89

openwrt-yun-1505

Updated build system for OpenWrt - Yun family boards
C
14
star
90

reference-pt

Portuguese version of the Arduino Reference
14
star
91

portenta-containers

TypeScript
14
star
92

the-things-conference

C
13
star
93

WiFi101-FirmwareUpdater-Plugin

WiFi101 Firmware Updater Tool for Arduino IDE
Java
13
star
94

reference-fr

12
star
95

libraries-repository-engine

Arduino Library Manager index manager
Go
12
star
96

lmp-manifest

Shell
12
star
97

season-of-docs

Arduino and Google's Season of Docs 2019
12
star
98

tooling-project-assets

A collection of reusable assets for Arduino tooling projects
Python
12
star
99

lede-yun

C
11
star
100

cloud-examples

Examples for Arduino Cloud
JavaScript
11
star