Merge branch 'docs/update_alerts_in_readmes_to_gfm_format' into 'master'

docs: Update alerts in READMEs to GFM format See merge request espressif/esp-idf!30628
safocl · May 8, 2024 · 40ec444 · 40ec444
2 parents 705c21d + 6cefbfd
commit 40ec444
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 6 deletions.
diff --git a/docs/TEMPLATE_EXAMPLE_README.md b/docs/TEMPLATE_EXAMPLE_README.md
@@ -13,8 +13,7 @@ _Example Title should use the word "example" instead of "demo", "test" or any si
 
 (For general overview of examples and their usage, see the `README.md` file in the upper level 'examples' directory.)
 
-> **Note**:
->
+> [!NOTE]
 > After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
 
 _What is this example? What does it do?_

diff --git a/examples/get-started/sample_project/README.md b/examples/get-started/sample_project/README.md
@@ -2,8 +2,7 @@
 
 (For general overview of examples and their usage, see the `README.md` file in the upper level 'examples' directory.)
 
-> **Note**:
->
+> [!NOTE]
 > After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
 
 This is the example of a simplest buildable project. It is also used by the command `idf.py create-project` which copies these files to the path specified by the user and sets the project name.

diff --git a/examples/system/esp_timer/README.md b/examples/system/esp_timer/README.md
@@ -5,8 +5,7 @@
 
 (For general overview of examples and their usage, see the [README](../../README.md) file in the upper level `examples` directory.)
 
-> **Note**:
->
+> [!NOTE]
 > After you click any link to [ESP-IDF Programming Guide](https://docs.espressif.com/projects/esp-idf/en/latest/index.html), go to the top of the sidebar, then make sure you have the appropriate **Espressif chip** (target) and **ESP-IDF version** selected in the dropdown menus.
 
 This example shows how to use the [ESP Timer](https://docs.espressif.com/projects/esp-idf/en/latest/api-reference/system/esp_timer.html) feature to create timers and execute callback functions. On the linked page, you will find detailed information about the feature as well as the functions and procedures used in this example.