Skip to content

Commit 9794b0a

Browse files
authored
Merge pull request #72 from arduino/sebromero/linter-fix-italic
Add quick fix for italic styling
2 parents 2725e7e + e634279 commit 9794b0a

File tree

62 files changed

+169
-98
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

62 files changed

+169
-98
lines changed

Diff for: .vscode/launch.json

+11
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,17 @@
1414
"program": "validate.js",
1515
"args": ["-p", "../../content"],
1616
"cwd": "${workspaceFolder}/scripts/validation/"
17+
},
18+
{
19+
"type": "pwa-node",
20+
"request": "launch",
21+
"name": "Debug Quickfix",
22+
"skipFiles": [
23+
"<node_internals>/**"
24+
],
25+
"program": "fix-issues.js",
26+
"args": ["-p", "../../content"],
27+
"cwd": "${workspaceFolder}/scripts/validation/"
1728
}
1829
]
1930
}

Diff for: content/hardware/01.mkr/01.boards/mkr-1000-wifi/tutorials/AnalogToMidi/AnalogToMidi.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -56,13 +56,13 @@ Defines the correspondence between notes and MIDI note values. Part of MIDIUSB
5656

5757
### Functions In Sketch
5858

59-
*searchForNote(float frequency)*
59+
**searchForNote(float frequency)**
6060
Search for the nearest frequency that is in the vector of frequencies noteFrequency[ ]
6161

62-
*noteOn(byte channel, byte pitch, byte velocity)*
62+
**noteOn(byte channel, byte pitch, byte velocity)**
6363
Sends out to MIDI the event to turn on the note of the specified pitch on the specified MIDI Channel
6464

65-
*void noteOff(byte channel, byte pitch, byte velocity)*
65+
**void noteOff(byte channel, byte pitch, byte velocity)**
6666
Sends out to MIDI the event to turn off the note of the specified pitch on the specified MIDI Channel
6767

6868
## Code

Diff for: content/hardware/01.mkr/01.boards/mkr-1000-wifi/tutorials/WiFi101OTA/WiFi101OTA.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -202,4 +202,4 @@ void printWifiStatus() {
202202

203203

204204

205-
*Last revision 2017/03/24 by AG*
205+
**Last revision 2017/03/24 by AG**

Diff for: content/hardware/01.mkr/01.boards/mkr-1000-wifi/tutorials/wifi-101-library-examples/wifi-101-library-examples.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -156,7 +156,7 @@ void loop() {
156156

157157
The 19.6.1 firmware is only available for model B of the WINC1500, this is used in the MKR1000 board. Unfortunately, the WiFi101 shield uses model A, which Atmel has stopped supporting, so there is no 19.6.1 firmware release for it, 19.4.4 will be the latest firmware version that is compatible.
158158

159-
To simplify the process, we have prepared a specific sketch - this *FirmwareUpdater* - that you must load on the host board (either the one with the shield plugged in, or the MKR1000 itself) and an easy to use plug-in available in Arduino Software (IDE) 1.6.10 onwards.
159+
To simplify the process, we have prepared a specific sketch - this **FirmwareUpdater** - that you must load on the host board (either the one with the shield plugged in, or the MKR1000 itself) and an easy to use plug-in available in Arduino Software (IDE) 1.6.10 onwards.
160160

161161
The `FirmwareUpdater.ino` sketch is available in **Examples > WiFi101**
162162

@@ -180,7 +180,7 @@ To update the firmware you should choose the right typer of board. You can find
180180

181181
![Find the model.](assets/MKR1000_RevA_B_20copy.png)
182182

183-
Choose in the dropdown list the model corresponding to your unit and proceed clicking on the *Update Firmware button*. A bar at the bottom will show you the progress of the procedure that includes erasing, writing and verifying of the firmware. At the end you get a clear notice of the successful operation.
183+
Choose in the dropdown list the model corresponding to your unit and proceed clicking on the **Update Firmware button**. A bar at the bottom will show you the progress of the procedure that includes erasing, writing and verifying of the firmware. At the end you get a clear notice of the successful operation.
184184

185185
![Firmware has been updated.](assets/firmware_uploaded_101.png)
186186

@@ -189,7 +189,7 @@ Choose in the dropdown list the model corresponding to your unit and proceed cli
189189
With the same procedure, you may load root certificates on the WiFi module to access securely specific websites. Your board must be running the **FirmwareUpdater** sketch to work .The root certificates are issued by a limited number of certification authorities, but it is difficult to know which site is using which authority. To ease your life, we allow you to specify directly the URL to which you need to connect securely, leaving to us the task to download the root certificate.
190190
The list you are building is not saved from one session to the next one. It might happen that a few websites share the same root certificate. You don't have to worry about this as we take care of it. The space available on your WiFi module to store the certificates is limited to around 10 certificates that, being issued by a limited number of authorities, should be more than enough for the average projects.
191191

192-
The procedure starts connecting your board (either the one with the shield plugged in, or the MKR1000 itself) to your computer and selecting it from the Tools menu of the Arduino Software (IDE). Load the FirmwareUpdater on the board and launch the *WiFi 101 Firmware Updater* from Tools and go to the third section of the interface.
192+
The procedure starts connecting your board (either the one with the shield plugged in, or the MKR1000 itself) to your computer and selecting it from the Tools menu of the Arduino Software (IDE). Load the FirmwareUpdater on the board and launch the **WiFi 101 Firmware Updater** from Tools and go to the third section of the interface.
193193

194194
![Adding SSL root certificates.](assets/certificates_upload_101.png)
195195

Diff for: content/hardware/01.mkr/01.boards/mkr-nb-1500/tutorials/securely-connecting-an-arduino-nb-1500-to-azure-iot-hub/securely-connecting-an-arduino-nb-1500-to-azure-iot-hub.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,7 +155,7 @@ In the Azure IoT Hub portal, click the device id row in the IoT Devices table fo
155155

156156
![Click "Message to device"](assets/screen_shot_2019-02-06_at_12_06_14_pm_554ggffxiP.png)
157157

158-
You can now enter a message body to send to the device, in the screenshot below "*Hello there :)*" was entered. Click the "Send Message" button in the toolbar to send the message.
158+
You can now enter a message body to send to the device, in the screenshot below "**Hello there :)**" was entered. Click the "Send Message" button in the toolbar to send the message.
159159

160160
![Send your message!](assets/screen_shot_2019-02-06_at_12_07_18_pm_jZHRAyebN2.png)
161161

Diff for: content/hardware/01.mkr/01.boards/mkr-vidor-4000/tutorials/VidorDrawLogo/VidorDrawLogo.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -126,4 +126,4 @@ void loop()
126126
```
127127

128128

129-
*Last revision 2018/07/22 by SM*
129+
**Last revision 2018/07/22 by SM**

Diff for: content/hardware/01.mkr/01.boards/mkr-vidor-4000/tutorials/VidorEnableCam/VidorEnableCam.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -107,4 +107,4 @@ void loop()
107107
```
108108

109109

110-
*Last revision 2018/07/22 by SM*
110+
**Last revision 2018/07/22 by SM**

Diff for: content/hardware/01.mkr/01.boards/mkr-vidor-4000/tutorials/VidorEncoder/VidorEncoder.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -155,4 +155,4 @@ void loop() {
155155
```
156156

157157

158-
*Last revision 2018/07/22 by SM*
158+
**Last revision 2018/07/22 by SM**

Diff for: content/hardware/01.mkr/01.boards/mkr-vidor-4000/tutorials/VidorQrRecognition/VidorQrRecognition.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -29,7 +29,7 @@ Include the VidorCamera library, which is part of VidorGraphics.
2929
`#include "VidorGraphics.h"`
3030
`#include "VidorCamera.h"`
3131

32-
You have a number of functions available to manage the recognition of a QR Code. VidorQR is part of the VidorCam library; the functions are accessible with *cam.qrrec*.
32+
You have a number of functions available to manage the recognition of a QR Code. VidorQR is part of the VidorCam library; the functions are accessible with **cam.qrrec**.
3333

3434
- `void begin()` - start recognition algorithm
3535

@@ -150,4 +150,4 @@ void loop() {
150150
}
151151
```
152152

153-
*Last revision 2018/07/22 by SM*
153+
**Last revision 2018/07/22 by SM**

Diff for: content/hardware/01.mkr/01.boards/mkr-wifi-1010/tutorials/atmel-ice/using-an-atmel-ice-with-the-ide-v2.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -99,9 +99,9 @@ If the SWD interfaces of the debugger and the board are connected properly, a **
9999

100100
## Using the Debugger Tool
101101

102-
Now that we have our hardware set up, we can learn how to use the IDE 2.0 Debugger Tool main functionalities through the [_Debugging with the Arduino IDE 2.0 tutorial_](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-debugger). This tutorial goes through some key features of the Debugger Tool, and includes pointers to get started.
102+
Now that we have our hardware set up, we can learn how to use the IDE 2.0 Debugger Tool main functionalities through the [**Debugging with the Arduino IDE 2.0 tutorial**](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-debugger). This tutorial goes through some key features of the Debugger Tool, and includes pointers to get started.
103103

104-
As explained in the [_Debugging with the Arduino IDE 2.0 tutorial_](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-debugger), before we can use the Debugger Tool of the Arduino IDE 2.0, we need to upload a sketch to our MKR WiFi 1010 board, making sure it is optimized for debugging. Let's try a simple program that blinks the onboard LED of our MKR WiFi 1010 board and changes the value of several variables while running.
104+
As explained in the [**Debugging with the Arduino IDE 2.0 tutorial**](https://docs.arduino.cc/software/ide-v2/tutorials/ide-v2-debugger), before we can use the Debugger Tool of the Arduino IDE 2.0, we need to upload a sketch to our MKR WiFi 1010 board, making sure it is optimized for debugging. Let's try a simple program that blinks the onboard LED of our MKR WiFi 1010 board and changes the value of several variables while running.
105105

106106
### 1. Setting Up
107107

Diff for: content/hardware/01.mkr/01.boards/mkr-wifi-1010/tutorials/securely-connecting-an-arduino-mkr-wifi-1010-to-aws-iot-core/securely-connecting-an-arduino-mkr-wifi-1010-to-aws-iot-core.md

+3-3
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ source: "https://create.arduino.cc/projecthub/Arduino_Genuino/securely-connectin
2424

2525
[AWS IoT Core](https://aws.amazon.com/iot-core/) is a managed cloud service that lets connected devices easily and securely interact with cloud applications and other devices. AWS IoT Core can support billions of devices and trillions of messages, and can process and route those messages to AWS endpoints and to other devices reliably and securely.
2626

27-
Devices can connect to AWS IoT Core using the following protocols: HTTP, WebSockets and MQTT. This tutorial will walk you through how to connect an [Arduino MKR WiFi 1010](https://store.arduino.cc/usa/arduino-mkr-wifi-1010) (or MKR1000) board securely to AWS IoT Core using the MQTT protocol. [MQTT](http://mqtt.org/) (*Message Queuing Telemetry Transport*) is an extremely lightweight M2M (machine-to-machine) connectivity protocol which provides a messaging subscription and publish transport.
27+
Devices can connect to AWS IoT Core using the following protocols: HTTP, WebSockets and MQTT. This tutorial will walk you through how to connect an [Arduino MKR WiFi 1010](https://store.arduino.cc/usa/arduino-mkr-wifi-1010) (or MKR1000) board securely to AWS IoT Core using the MQTT protocol. [MQTT](http://mqtt.org/) (**Message Queuing Telemetry Transport**) is an extremely lightweight M2M (machine-to-machine) connectivity protocol which provides a messaging subscription and publish transport.
2828

2929
When connecting to AWS IoT Core using MQTT, devices are required to use X.509 certificates with TLS for authentication, as AWS IoT Core does not support authentication via username and password like many other MQTT broker services provide support for. More information on X.509 certificate support on AWS IoT can be found [here](https://docs.aws.amazon.com/iot/latest/developerguide/x509-certs.html).
3030

@@ -114,7 +114,7 @@ Now that we have a CSR to identify the board, we need to login into the AWS cons
114114

115115
![Create a policy.](assets/screen_shot_2019-01-14_at_3_25_34_pm_C67jg7LTXy.png)
116116

117-
13) Click "Create a policy." We'll be creating a very open policy for testing, **later on we suggest you create a stricter policy**. We'll call this policy "AllowEverything," fill in "iot:*" for the Action and "*" for the Resource ARN, then check the "Allow" box, then click "Create."
117+
13) Click "Create a policy." We'll be creating a very open policy for testing, **later on we suggest you create a stricter policy***. We'll call this policy "AllowEverything," fill in "iot:\*" for the Action and "\*" for the Resource ARN, then check the "Allow" box, then click "Create."
118118

119119
![Click create.](assets/screen_shot_2019-01-14_at_3_26_58_pm_bkfMovt51e.png)
120120

@@ -175,7 +175,7 @@ Now that your board has successfully connected to AWS IoT, we can use the AWS co
175175

176176
Every five seconds the board sends a hello message with the current millis() value.
177177

178-
Now let's send a message to the board. In the Publish section, change the topic to **arduino/incoming** and click the "Publish to topic" button*.*
178+
Now let's send a message to the board. In the Publish section, change the topic to **arduino/incoming** and click the "Publish to topic" button.
179179

180180
![Click Publish to topic.](assets/screen_shot_2019-01-14_at_5_53_47_pm_LKDzWUW8VV.png)
181181

Diff for: content/hardware/01.mkr/03.carriers/mkr-iot-carrier/tutorials/mkr-iot-carrier-01-technical-reference/mkr-iot-carrier-01-technical-reference.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -106,7 +106,7 @@ The `carrier.begin();` command is essential to initializing the carrier and must
106106

107107
![The HTS221 Humidity Sensor on the MKR IoT Carrier](assets/mkrIotCarrier-sensor-temp&humi.png)
108108

109-
The **HTS221 Humidity Sensor** is mounted on the top side of the carrier under the display, marked with a drop icon. The sensor uses capacitive sensing with a **humidity sensing range** of _0-100%_ and **accuracy** of _± 3.5% rH (20 to +80% rH)_, and a **temperature sensing range** of _-40 to 120° C_, with an **accuracy** of _± 0.5 °C,15 to +40 °C_. The sensor uses a low power consumption (2μA at 1 Hz sampling rate) and connects to the mounted Arduino MKR board through a I2C interface.
109+
The **HTS221 Humidity Sensor** is mounted on the top side of the carrier under the display, marked with a drop icon. The sensor uses capacitive sensing with a **humidity sensing range** of **0-100%** and **accuracy** of **± 3.5% rH (20 to +80% rH)**, and a **temperature sensing range** of **-40 to 120° C**, with an **accuracy** of **± 0.5 °C,15 to +40 °C**. The sensor uses a low power consumption (2μA at 1 Hz sampling rate) and connects to the mounted Arduino MKR board through a I2C interface.
110110

111111
### Code
112112

@@ -135,7 +135,7 @@ Returns relative humidity (rH) in percentage.
135135

136136
![The LPS22HBTR Pressure Sensor on the MKR IoT Carrier](assets/mkrIotCarrier-sensor-pressure.png)
137137

138-
The **LPS22HBTR Pressure Sensor** is mounted on the top side of the carrier under the display, marked with a meter icon. The sensor measures **absolute pressure range** of _260 to 1260 hPa (0.25 to 1.24 atm)_ and connects to the mounted Arduino MKR board through a I2C interface.
138+
The **LPS22HBTR Pressure Sensor** is mounted on the top side of the carrier under the display, marked with a meter icon. The sensor measures **absolute pressure range** of **260 to 1260 hPa (0.25 to 1.24 atm)** and connects to the mounted Arduino MKR board through a I2C interface.
139139

140140
### Code
141141

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/Bridge/Bridge.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -128,7 +128,7 @@ void process(YunClient client) {
128128
}
129129
```
130130

131-
Create a function to deal with *digital* commands. Accept the client as the argument. Create some local variables to hold the pin and value of the command.
131+
Create a function to deal with **digital** commands. Accept the client as the argument. Create some local variables to hold the pin and value of the command.
132132

133133
```arduino
134134
void digitalCommand(YunClient client) {
@@ -162,7 +162,7 @@ Print the value to the client and update the datastore key with the current pin
162162

163163
By wrapping the value to the client in `F()`, you'll be printing form the flash memory. This helps conserve space in SRAM, which is useful when dealing with long strings like URLs.
164164

165-
The key will be the pin, and type. For example *D2* will be saved for for digital pin 2. The value will be whatever value the pin is currently set to, or was read from the pin.
165+
The key will be the pin, and type. For example **D2** will be saved for for digital pin 2. The value will be whatever value the pin is currently set to, or was read from the pin.
166166

167167
```arduino
168168
client.print(F("Pin D"));

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/ConsoleAsciiTable/ConsoleAsciiTable.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -236,4 +236,4 @@ void loop() {
236236
}
237237
```
238238

239-
*Last revision 2016/05/25 by SM*
239+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/ConsolePixel/ConsolePixel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -187,4 +187,4 @@ void loop() {
187187
}
188188
```
189189

190-
*Last revision 2016/05/25 by SM*
190+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/ConsoleRead/ConsoleRead.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -190,4 +190,4 @@ void loop() {
190190
```
191191

192192

193-
*Last revision 2016/05/25 by SM*
193+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/FileWriteScript/FileWriteScript.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -252,4 +252,4 @@ void runScript() {
252252
}
253253
```
254254

255-
*Last revision 2016/05/25 by SM*
255+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/HttpClient/HttpClient.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,4 @@ The complete sketch is below :
8080

8181
<iframe src='https://create.arduino.cc/example/library/bridge_1_7_0/bridge_1_7_0%5Cexamples%5CHttpClient/HttpClient/preview?embed' style='height:510px;width:100%;margin:10px 0' frameborder='0'></iframe>
8282

83-
*Last revision 2016/05/25 by SM*
83+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/HttpClientConsole/HttpClientConsole.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -159,4 +159,4 @@ void loop() {
159159
```
160160

161161

162-
*Last revision 2016/05/25 by SM*
162+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/LinuxCLI/LinuxCLI.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -43,7 +43,7 @@ This document has additional information about [using the CLI and OpenWRT](http:
4343

4444
SSH is shorthand for Secure Shell, a terminal protocol for securely connecting between two computers. You'll use SSH to connect between your computer and the Yún.
4545

46-
To connect via SSH, you need the IP address of the Yún, the administrator password, and you'll need to have the Arduino and the computer you're using on the same network. To find the Yun's IP address, make sure you're on the same wireless network, and open the Arduino software. Check the *Ports* list, the Yún should be listed with its address.
46+
To connect via SSH, you need the IP address of the Yún, the administrator password, and you'll need to have the Arduino and the computer you're using on the same network. To find the Yun's IP address, make sure you're on the same wireless network, and open the Arduino software. Check the **Ports** list, the Yún should be listed with its address.
4747

4848
To connect to your Yún via SSH, open your terminal application, type the following, substituting the IP address for that of your Yún :
4949

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/MailboxReadMessage/MailboxReadMessage.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -203,4 +203,4 @@ void loop() {
203203
}
204204
```
205205

206-
*Last revision 2016/05/25 by SM*
206+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/Process/Process.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -222,4 +222,4 @@ void runCpuInfo() {
222222
```
223223

224224

225-
*Last revision 2016/05/25 by SM*
225+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/RemoteDueBlink/RemoteDueBlink.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -82,4 +82,4 @@ void loop() {
8282
```
8383

8484

85-
*Last revision 2016/05/25 by SM*
85+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/ShellCommands/ShellCommands.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -180,4 +180,4 @@ void loop() {
180180
```
181181

182182

183-
*Last revision 2016/05/25 by SM*
183+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/TemperatureWebPanel/TemperatureWebPanel.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -407,4 +407,4 @@ void loop() {
407407
}
408408
```
409409

410-
*Last revision 2016/05/25 by SM*
410+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/TimeCheck/TimeCheck.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -277,4 +277,4 @@ void loop() {
277277
```
278278

279279

280-
*Last revision 2016/05/25 by SM*
280+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/WiFiStatus/WiFiStatus.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -154,4 +154,4 @@ void loop() {
154154
```
155155

156156

157-
*Last revision 2016/05/25 by SM*
157+
**Last revision 2016/05/25 by SM**

Diff for: content/hardware/02.hero/boards/yun-rev2/tutorials/YunDatalogger/YunDatalogger.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -306,4 +306,4 @@ String getTimeStamp() {
306306
}
307307
```
308308

309-
*Last revision 2016/05/25 by SM*
309+
**Last revision 2016/05/25 by SM**

0 commit comments

Comments
 (0)