Fix markdownlist workflow 🎉

[AntonioBerna]

🧠 Overview

The markdownlint workflow was generating the following errors:

./README.md:58:1 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
./README.md:58 MD028/no-blanks-blockquote Blank line inside blockquote
./README.md:73 MD028/no-blanks-blockquote Blank line inside blockquote
./README.md:1459:677 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]
./README.md:1464:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1464 MD032/blanks-around-lists Lists should be surrounded by blank lines [Context: "* Logic (Propositional, Quanti..."]
./README.md:1465:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1466:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1467:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1468:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1469:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1470:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1471:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1472:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1473:1 MD004/ul-style Unordered list style [Expected: dash; Actual: asterisk]
./README.md:1480:103 MD009/no-trailing-spaces Trailing spaces [Expected: 0 or 2; Actual: 1]

✅ Proposed Solution

1. Replace all asterisks with dashes;

2. Use explicit comment:

   <!-- markdownlint-disable MD028 -->
   ...
   <!-- markdownlint-enable MD028 -->

   to ignore the warning due to the space left in the following code (between NOTE and TIP):

   <!-- markdownlint-disable MD028 -->
   
   > [!NOTE]
   > **Remember that the importance of individual software and hardware skills can differ depending on the specific requirements of the company and the job role.**
        <--- line 58
   > [!TIP]
   > To differentiate between the types of learning resources and the quality of their content, specific symbols are used before each item.
   >
   > **Resource types:**
   >
   > - 📘 : Books
   > - 🎞️ : Videos
   > - 📝 : Write-ups, articles, and blog posts
   > - 🔗 : Other links that do not fit into any of the above categories
   >
   > **Content quality symbols:**
   >
   > - 👶 : Easy-to-understand and beginner-friendly resources. Refer to them if you do not have prior knowledge in a topic.
   > - 💎 : Well-known references that have truly invaluable and comprehensive content. Refer to them if you want to deepen your understanding of a topic.
   
   <!-- markdownlint-enable MD028 -->

3. Other changes that can be verified directly from the code.

🧪 Local Test

Using the very good tool called act I ran the workflow locally and everything went well:

$ act
[Markdownlint/Markdown Lint Check] ⭐ Run Set up job
[Markdownlint/Markdown Lint Check] 🚀  Start image=catthehacker/ubuntu:act-latest
[Markdownlint/Markdown Lint Check]   🐳  docker pull image=catthehacker/ubuntu:act-latest platform= username= forcePull=true
[Markdownlint/Markdown Lint Check] using DockerAuthConfig authentication for docker pull
[Markdownlint/Markdown Lint Check]   🐳  docker create image=catthehacker/ubuntu:act-latest platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[Markdownlint/Markdown Lint Check]   🐳  docker run image=catthehacker/ubuntu:act-latest platform= entrypoint=["tail" "-f" "/dev/null"] cmd=[] network="host"
[Markdownlint/Markdown Lint Check]   🐳  docker exec cmd=[node --no-warnings -e console.log(process.execPath)] user= workdir=
[Markdownlint/Markdown Lint Check]   ✅  Success - Set up job
[Markdownlint/Markdown Lint Check] ⭐ Run Main Install markdownlint-cli
[Markdownlint/Markdown Lint Check]   🐳  docker exec cmd=[bash -e /var/run/act/workflow/0] user= workdir=
[Markdownlint/Markdown Lint Check]   ✅  Success - Main Install markdownlint-cli [9.044320404s]
[Markdownlint/Markdown Lint Check] ⭐ Run Main Checkout code
[Markdownlint/Markdown Lint Check]   🐳  docker cp src=/Users/clevercode/Desktop/github/Embedded-Engineering-Roadmap/. dst=/Users/clevercode/Desktop/github/Embedded-Engineering-Roadmap
[Markdownlint/Markdown Lint Check]   ✅  Success - Main Checkout code [424.819334ms]
[Markdownlint/Markdown Lint Check] ⭐ Run Main Run markdownlint
[Markdownlint/Markdown Lint Check]   🐳  docker exec cmd=[bash -e /var/run/act/workflow/2] user= workdir=
| Checking Markdown files
[Markdownlint/Markdown Lint Check]   ✅  Success - Main Run markdownlint [1.851013009s]
[Markdownlint/Markdown Lint Check] ⭐ Run Complete job
[Markdownlint/Markdown Lint Check] Cleaning up container for job Markdown Lint Check
[Markdownlint/Markdown Lint Check]   ✅  Success - Complete job
[Markdownlint/Markdown Lint Check] 🏁  Job succeeded

---

@m3y54m please let me know if you agree with this kind of changes. Enjoy 🎉