chore: use alerts Markdown extension instead of images

See https://docs.github.com/en/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax#alerts

Signed-off-by: Frederic Pillon <[email protected]>

Author: fpistm

API.md

@@ -58,7 +58,8 @@ _Params_ `func` pointer to the callback function
 * `void unregisterCoreCallback(void (*func)(void))`: unregister a callback function  
 _Params_ `func` pointer to the callback function  
 
-[[/img/Warning-icon.png|alt="Warning"]] By default, the core callback feature is disabled, to enable it `CORE_CALLBACK` must be defined.
+> [!WARNING]
+> By default, the core callback feature is disabled, to enable it `CORE_CALLBACK` must be defined.
 
 [`build_opt.h`][build_opt.h] can be used to define it by adding `-DCORE_CALLBACK`.
 
@@ -77,7 +78,8 @@ As each pin has not the same capabilities, it uses the best way:
 ### Frequency
 `analogWriteFrequency(freq)` has been added in core version greater than **1.5.0** to set the frequency used by `analogWrite()`. Default is `PWM_FREQUENCY` (1000) in Hertz.
 
-**_Note_** frequency is common to all channels of a specified timer, setting the frequency for one channel will impact all others of the same timer.
+> [!NOTE]
+> frequency is common to all channels of a specified timer, setting the frequency for one channel will impact all others of the same timer.
 
 #### Example
 ```C
@@ -109,7 +111,8 @@ to the desired ADC sample time.
 An example which read then convert to proper Unit the 3 internal channels + A0 is provided with [STM32Examples](https://github.com/stm32duino/STM32Examples) library:
 [Internal_channels](https://github.com/stm32duino/STM32Examples/blob/main/examples/Peripherals/ADC/Internal_channels/Internal_channels.ino)
 
-[[/img/Warning-icon.png|alt="Warning"]] This example is provided "as it" and can require some update mainly for datasheet values.
+> [!WARNING]
+> This example is provided "as it" and can require some update mainly for datasheet values.
 
 ## HardwareSerial
 
@@ -140,7 +143,8 @@ void loop() {
 Another solution is to add a [`build_opt.h`][build_opt.h] file alongside your main `.ino` file with: `-DENABLE_HWSERIALx`.
 This will define the `Serialx` instance using the first `USARTx` instance found in the `PeripheralPins.c` of your variant.
 
-[[/img/Note-icon.png|alt="Note"]] **Note** that only the latter solution allows to use the `serialEventx()` callback in the sketch.
+> [!NOTE]
+> that only the latter solution allows to use the `serialEventx()` callback in the sketch.
 
 For Example, if you define in the [`build_opt.h`][build_opt.h]: `-DENABLE_HWSERIAL3`
 
@@ -167,7 +171,8 @@ It is also possible to change the default pins used by the `Serial` instance usi
 * `void setRx(PinName rx)`
 * `void setTx(PinName tx)`
 
-[[/img/Warning-icon.png|alt="Warning"]] **Have to be called before `begin()`.**
+> [!WARNING]
+> Have to be called before `begin()`.
 
 ##### Example:
 ```C++
@@ -289,7 +294,8 @@ void loop() {
 }
 ```
 
-**Note:** Serial Rx/TX buffer size can be changed, see [[custom definitions|Custom-definitions#serial-rxtx-buffer-size]]
+> [!NOTE]
+> Serial Rx/TX buffer size can be changed, see [[custom definitions|Custom-definitions#serial-rxtx-buffer-size]]
 
 #### Enable hardware flow control
 
@@ -366,7 +372,8 @@ void setup() {
 #### Change default `SPI` instance pins 
 It is also possible to change the default pins used by the `SPI` instance using above API:
 
-[[/img/Warning-icon.png|alt="Warning"]] **Have to be called before `begin()`.**
+> [!WARNING]
+> Have to be called before `begin()`.
 
 * `void setMISO(uint32_t miso)`
 * `void setMOSI(uint32_t mosi)`
@@ -377,7 +384,8 @@ It is also possible to change the default pins used by the `SPI` instance using
 * `void setSCLK(PinName sclk)`
 * `void setSSEL(PinName ssel)`
 
-**_Note 1_** Using `setSSEL()` allows to enable hardware CS pin management linked to the SPI peripheral.
+> [!NOTE]
+> Using `setSSEL()` allows to enable hardware CS pin management linked to the SPI peripheral.
 
 ##### Example:
 ```C++
@@ -476,7 +484,8 @@ It is also possible to change the default pins used by the `Wire` instance using
 * `void setSCL(PinName scl)`
 * `void setSDA(PinName sda)`
 
-[[/img/Warning-icon.png|alt="Warning"]] **Have to be called before `begin()`.**
+> [!WARNING]
+> Have to be called before `begin()`.
 
 ##### Example:
 ```C++
@@ -563,13 +572,14 @@ In this case, following switches should be defined (in variant.h or [`build_opt.
 
 see example of variant implementation: [#938](../pull/938)
 
-[[/img/Warning-icon.png|alt="Warning"]] **Single/dual bank configuration**:
-
-Default last sector used correspond to default board configuration.  
-
-For example, NUCLEO_F767ZI is by default configured in single bank. Last sector correspond to this bank configuration.  
-If this configuration is changed, it is then mandatory to customize `FLASH_BASE_ADDRESS`/`FLASH_DATA_SECTOR`,
-even to use last sector of Flash.
+> [!WARNING]
+> Single/dual bank configuration:
+>
+> Default last sector used correspond to default board configuration.
+>
+> For example, NUCLEO_F767ZI is by default configured in single bank. Last sector correspond to this bank configuration.
+> If this configuration is changed, it is then mandatory to customize `FLASH_BASE_ADDRESS`/`FLASH_DATA_SECTOR`,
+> even to use last sector of Flash.
 
 ## [[Servo library]]
 

FAQ.md

@@ -17,7 +17,8 @@ Node names list has to be separated by ',' and double quoted (for Windows).
 
 ### When using "STLink" upload method on Windows, nothing is happening:
 
-[[/img/Warning-icon.png|alt="Warning"]] _**deprecated since core version > 1.5.0**_
+> [!WARNING]
+> deprecated since core version higher than 1.5.0
 
 This is probably due to the missing `MSVCR100.dll`.
 

HardwareTimer-library.md

@@ -13,7 +13,8 @@
 	/vscode-markdown-toc-config -->
 <!-- /vscode-markdown-toc -->
 
-[[/img/Warning-icon.png|alt="Warning"]] Needs *Arduino_Core_STM32* version > 1.6.1
+> [!WARNING]
+> Requires *Arduino_Core_STM32* version higher than 1.6.1
 
 ##  1. <a name='Introduction'></a>Introduction
 
@@ -29,7 +30,8 @@ __Example__:
 
 Each timer may provide several channels, nevertheless it is important to understand that all channels of the same timer share the same counter and thus have the same period/frequency.
 
-[[/img/Warning-icon.png|alt="Warning"]] __For genericity purpose, HardwareTimer library uses all timers like a 16bits timer (even if some may be wider).__
+> [!WARNING]
+> For genericity purpose, HardwareTimer library uses all timers like a 16bits timer (even if some may be wider).
 
 
 ##  2. <a name='API'></a>API
@@ -96,7 +98,8 @@ Each timer may provide several channels, nevertheless it is important to underst
 
 `HardwareTimer` is a C++ class, 1st thing to do is to instantiate an object with `TIM` instance as parameter.
 
-[[/img/Note-icon.png|alt="Note"]] Some instances are used by Servo, Tone and SoftSerial (see TIMER_SERVO, TIMER_TONE and TIMER_SERIAL) but only when they are used. Just be sure there is no conflict with your own usage.
+> [!NOTE]
+> Some instances are used by Servo, Tone and SoftSerial (see TIMER_SERVO, TIMER_TONE and TIMER_SERIAL) but only when they are used. Just be sure there is no conflict with your own usage.
 
 __Example__:
 ```C++
@@ -105,9 +108,11 @@ __Example__:
 
 Then it is possible to configure mode of a channel.
 
-[[/img/Note-icon.png|alt="Note"]] No need to configure pin mode (output/input/AlternateFunction), it will be done automatically by HardwareTimer library.
+> [!NOTE]
+> No need to configure pin mode (output/input/AlternateFunction), it will be done automatically by HardwareTimer library.
 
-[[/img/Note-icon.png|alt="Note"]] Channel range [1..4], but not all timers support 4 channels.
+> [!NOTE]
+> Channel range [1..4], but not all timers support 4 channels.
 
 __Example__: 
 ```C++
@@ -145,11 +150,14 @@ typedef enum {
 Then it is possible to configure *PrescalerFactor*. The Timer clock will be divided by this factor (if timer clock is 10Khz, and prescaler factor is 2, then timer will count at 5kHz).
 
 
-[[/img/Note-icon.png|alt="Note"]] Configuration of *prescaler* is automatic when using method `setOverflow` with `format == MICROSEC_FORMAT` or `format == HERTZ_FORMAT`.
+> [!NOTE]
+> Configuration of *prescaler* is automatic when using method `setOverflow` with `format == MICROSEC_FORMAT` or `format == HERTZ_FORMAT`.
 
-[[/img/Note-icon.png|alt="Note"]] *Prescaler* is for timer counter and thus is common to all channel.
+> [!NOTE]
+> *Prescaler* is for timer counter and thus is common to all channel.
 
-[[/img/Note-icon.png|alt="Note"]] *PrescalerFactor* range: [1.. 0x10000]  (Hardware register will range [0..0xFFFF]).
+> [!NOTE]
+> *PrescalerFactor* range: [1.. 0x10000]  (Hardware register will range [0..0xFFFF]).
 
 __Example__:
 ```C++
@@ -162,11 +170,14 @@ For __output__ it correspond to period or frequency.
 
 For __input capture__ it is suggested to use max value: 0x10000 to avoid rollover before capture occurs .
 
-[[/img/Note-icon.png|alt="Note"]] Configuration of *prescaler* is automatic when using method `setOverflow` with `format == MICROSEC_FORMAT` or `format == HERTZ_FORMAT`.
+> [!NOTE]
+> Configuration of *prescaler* is automatic when using method `setOverflow` with `format == MICROSEC_FORMAT` or `format == HERTZ_FORMAT`.
 
-[[/img/Note-icon.png|alt="Note"]] *overflow* is common to all channel.
+> [!NOTE]
+> *overflow* is common to all channel.
 
-[[/img/Note-icon.png|alt="Note"]] *Overflow* range: [1.. 0x10000] (Hardware register will range [0..0xFFFF]).
+> [!NOTE]
+> *Overflow* range: [1.. 0x10000] (Hardware register will range [0..0xFFFF]).
 
 __Example__:
 ```C++
@@ -178,9 +189,11 @@ __Example__:
 
 Then it is possible to configure *CaptureCompare* (channel specific CaptureCompare register).
 
-[[/img/Note-icon.png|alt="Note"]] *CaptureCompare* is for one channel only.
+> [!NOTE]
+> *CaptureCompare* is for one channel only.
 
-[[/img/Note-icon.png|alt="Note"]] *CaptureCompare* range: [0.. 0xFFFF]
+> [!NOTE]
+> *CaptureCompare* range: [0.. 0xFFFF]
 
 __Example__:
 ```C++
@@ -204,7 +217,8 @@ __Example__:
 
 It is now time to start timer.
 
-[[/img/Note-icon.png|alt="Note"]] All channel of the same timer are started at the same time (as there is only 1 counter per timer).
+> [!NOTE]
+> All channel of the same timer are started at the same time (as there is only 1 counter per timer).
 
 __Example__:
 ```C++
@@ -252,7 +266,8 @@ Also, to get ride of Interrupt callback:
 ```C++
     detachInterrupt()
 ```
-[[/img/Note-icon.png|alt="Note"]] Once the timer is started with the callback enabled you can disable and enable the callback through `detachInterrupt` and `attachInterrupt` freely, how many times you want. However, if the first `resume` (= timer start) is done without **before** calling `attachInterrupt`, the HardwareTimer will **not** be able to attach the interrupt later (for performance reasons the timer will be started with interrupts disabled)
+> [!NOTE]
+> Once the timer is started with the callback enabled you can disable and enable the callback through `detachInterrupt` and `attachInterrupt` freely, how many times you want. However, if the first `resume` (= timer start) is done without **before** calling `attachInterrupt`, the HardwareTimer will **not** be able to attach the interrupt later (for performance reasons the timer will be started with interrupts disabled)
 
 If you detach and attach interrupts while the timer is running, starting from version 1.8.0, you can also know if there's a callback already attached (without the need to track it externally) through the method
 ```C++
@@ -306,7 +321,8 @@ Following examples are provided in [STM32Examples](https://github.com/stm32duino
         External signal (signal generator for example) should be connected to `D2`.
 
 ##  5. <a name='Dependencies'></a>Dependencies
-[[/img/Warning-icon.png|alt="Warning"]] Needs *Arduino_Core_STM32* version > 1.6.1
+> [!WARNING]
+> Required *Arduino_Core_STM32* version higher than 1.6.1
 
 *Tone*, *Servo* and *analogwrite* have been updated to use *HardwareTimer*.
 

Libraries.md

@@ -11,12 +11,14 @@ Libraries using basic features like Serial, SPI, I2C,... should be fully compati
 * [Third party](#third-party)
   * [Tested](#tested)
 
-[[/img/Warning-icon.png|alt="Warning"]] _Arduino boards provide ICSP connector used by several Arduino shields for SPI signal: MISO/MOSI/SCK. STM32 boards do not have this ICSP connector, so this requires to manually wire those SPI signals to the desired pin (mainly: D11 to D13)_
+> [!WARNING]
+> Arduino boards provide ICSP connector used by several Arduino shields for SPI signal: MISO/MOSI/SCK. STM32 boards do not have this ICSP connector, so this requires to manually wire those SPI signals to the desired pin (mainly: D11 to D13)
 
-[[/img/Note-icon.png|alt="Note"]] All dedicated STM32 libraries are available through the "_**Library Manager**_"
-or have a look hereafter to see which one is available:
-
-* http://www.arduinolibraries.info/architectures/stm32
+> [!NOTE]
+> All dedicated STM32 libraries are available through the "_**Library Manager**_"
+> or have a look hereafter to see which one is available:
+>
+> * http://www.arduinolibraries.info/architectures/stm32
 
 ## Built-in (delivered with the core package)
 
@@ -102,7 +104,9 @@ These libraries are guaranteed to work fine with all NUCLEO boards supported in
 * [X-NUCLEO-GNSS1A1](https://github.com/stm32duino/X-NUCLEO-GNSS1A1): to support the X-NUCLEO-GNSS1A1 expansion board using the TESEO-LIV3F module. It depends on the following libraries:
   * [MicroNMEA](https://github.com/stevemarple/MicroNMEA)
 
-[[/img/Note-icon.png|alt="Note"]] In order to perform the firmware upgrade, the following Java application should be used:
+> [!NOTE]
+> In order to perform the firmware upgrade, the following Java application should be used:
+
   * [Teseo-LIV3F-Flash-Updater](https://github.com/stm32duino/Teseo-LIV3F-Flash-Updater)
 
 * [X-NUCLEO-IDB05A1](https://github.com/stm32duino/X-NUCLEO-IDB05A1): it is a Bluetooth Low Energy evaluation board based on the SPBTLE-RF BlueNRG-MS RF module. It depends on the following library: