Reference-en is the repo for the Language Reference documentation of the Arduino syntax in English. All the Reference terms files are in AsciiDoc format.
Thank you for taking the time to contribute to Arduino content, this is really helpful to the whole Arduino Community. If you want to learn more about how to contribute to this project, please check this step by step tutorial.
If you want to contribute new content, create a new file (with any text or code editor) and save it as .adoc.
Do not use parenthesis or any special character in the file name.
In reference-en/AsciiDoc_sample/AsciiDoc_Dictionary you will find an overview of the AsciiDoc syntax. This includes Titles, Text, Links, Images, Tables, Code and various embeds (video, slideshow, audio, and code). You can see it rendered here.
If you want to contribute to the Language Reference or edit existing content, you can find two templates in reference-en/AsciiDoc_sample/Reference_Terms:
-
Use
AsciiDoc_Template-Single_Entity.adoc(rendered here) for terms such as analogWrite. -
Use
AsciiDoc_Template-Parent_Of_Entities.adoc(rendered here) for groups of functions such as Serial.
Please note that every Reference file should include at least a Description, some Example Code, and links to other relevant info (See Also section).
If you need to add images to the Asciidoc please create a folder called attachments in the same directory as the Asciidoc file. Images can be saved in SVG and PNG format, max size 200KB.
If you are not familiar with Git you can contribute content directly on Github via their online interface. We put together a short Tutorial to show you how - CHECK IT OUT!
You can also follow this guide (written by the Github team) to learn how to edit an .adoc file and propose a file change to the Arduino team. When suggesting a change, please follow the guidelines described in the Reference template files.
We are glad you want to contribute to the Arduino Reference: that’s the best way to help the community.
Your contribution is adding or modifying existing code or full descriptions, please always refer to an existing issue or open a new one before contributing.
reference-en
├─ AsciiDoc_sample
│ ├── AsciiDoc_Dictionary
│ │ ├── AsciiDoc_Template-Dictionary.adoc
│ │ └── attachments
│ └── Reference_Terms
│ ├── AsciiDoc_Template-Parent_Of_Entities.adoc
│ ├── AsciiDoc_Template-Single_Entity.adoc
│ └── attachments
├── Language
│ ├── Functions
│ ├── Structure
│ └── Variables
├── LICENCE.md
└── README.adocWithin the Language folder, the file tree follows the same structure as in the Arduino Reference webpage
Please note that your contribution to the Arduino Reference is licensed under a Creative Commons Attribution-Share Alike 3.0 License. see https://creativecommons.org/licenses/by-sa/3.0/
