Code style check: check the syntax of markdown files (#9394)

.github/workflows/code_style_check.yml

@@ -32,3 +32,5 @@ jobs:
         (grep "VALUE \"LegalCopyright\", *\"\\\\251 $(date +%Y) fheroes2 Resurrection team" src/resources/fheroes2.rc > /dev/null && \
          echo "The date specified in the LegalCopyright entry is valid.") || \
         (echo "Please update the date in the LegalCopyright entry!" && false)
+    - name: Check format of markdown files
+      uses: DavidAnson/markdownlint-cli2-action@v19

.markdownlint-cli2.jsonc

@@ -0,0 +1,49 @@
+{
+    "config": {
+        "default": true,
+        "heading-style": {
+            "style": "atx"
+        },
+        "ul-style": {
+            "style": "asterisk"
+        },
+        "no-trailing-spaces": {
+            "strict": true
+        },
+        "line-length": {
+            "code_block_line_length": 170,
+            "heading_line_length": 170,
+            "line_length": 170
+        },
+        "no-inline-html": {
+            "allowed_elements": [
+                "a",
+                "details",
+                "img",
+                "p",
+                "summary"
+            ]
+        },
+        "code-block-style": {
+            "style": "fenced"
+        },
+        "code-fence-style": {
+            "style": "backtick"
+        },
+        "emphasis-style": {
+            "style": "underscore"
+        },
+        "strong-style": {
+            "style": "asterisk"
+        },
+        "table-pipe-style": {
+            "style": "leading_and_trailing"
+        }
+    },
+    "globs": [
+        "**/*.md"
+    ],
+    "ignores": [
+        "cmake/README_findsdl2.md"
+    ]
+}

CONTRIBUTING.md

@@ -1,4 +1,4 @@
-## Contribution and Development
+# Contribution and Development
 
 This repository is a place for everyone. If you want to contribute, please read more [**here**](https://github.com/ihhub/fheroes2/wiki/F.A.Q.#q-how-can-i-contribute-to-the-project).
 

README.md

@@ -9,11 +9,12 @@ and user interface improvements), breathing new life into one of the most addict
 You can find a complete list of all of our changes and enhancements in [**its own wiki page**](https://github.com/ihhub/fheroes2/wiki/Features-and-enhancements-of-the-project).
 
 <p align="center">
-    <img src="docs/images/screenshots/screenshot_world_map.png?raw=true" width="820">
+    <img src="docs/images/screenshots/screenshot_world_map.png?raw=true" width="820" alt="Screenshot of the world map">
 </p>
 
 <p align="center">
-    <img src="docs/images/screenshots/screenshot_battle.png?raw=true" width="410"> <img src="docs/images/screenshots/screenshot_castle.png?raw=true" width="410">
+    <img src="docs/images/screenshots/screenshot_battle.png?raw=true" width="410" alt="Screenshot of the battle screen">
+    <img src="docs/images/screenshots/screenshot_castle.png?raw=true" width="410" alt="Screenshot of the castle screen">
 </p>
 
 ## Download and install
@@ -52,8 +53,8 @@ If you would like to help translating the project, please read the [**translatio
 
 ## Donation
 
-We accept donations via [**Patreon**](https://www.patreon.com/fheroes2), [**PayPal**](https://www.paypal.com/paypalme/fheroes2) or [**Boosty**](https://boosty.to/fheroes2). All donations will be used only for the future project development as we do not
-consider this project as a source of income by any means.
+We accept donations via [**Patreon**](https://www.patreon.com/fheroes2), [**PayPal**](https://www.paypal.com/paypalme/fheroes2) or [**Boosty**](https://boosty.to/fheroes2).
+All donations will be used only for the future project development as we do not consider this project as a source of income by any means.
 
 [![Donate](https://img.shields.io/badge/Donate-Patreon-green.svg)](https://www.patreon.com/fheroes2)
 [![Donate](https://img.shields.io/badge/Donate-PayPal-green.svg)](https://www.paypal.com/paypalme/fheroes2)

docs/DEVELOPMENT.md

@@ -6,7 +6,6 @@ Please follow the instructions below to be able to build the project from source
 
 **Note:** You will need to clone the `fheroes2` project before following the instructions below.
 
-<a name="windows"></a>
 ### Windows
 
 * Go to the directory `script/windows` and run the file `install_packages.bat`. This script will install all the
@@ -18,7 +17,6 @@ Please follow the instructions below to be able to build the project from source
 * Open the file `fheroes2-vs2019.vcxproj` (targeted for Visual Studio 2019) and build the project.
 * Visual Studio will automatically copy game files in the root directory to the build directory.
 
-<a name="macos-and-linux"></a>
 ### macOS and Linux
 
 * Depending on your OS, run the following scripts to install the dependencies required for the build:
@@ -30,25 +28,21 @@ Please follow the instructions below to be able to build the project from source
   This script will download a demo version of the original game, which is the minimum required for development.
 * Run the `make` command in the root directory of the project to build it.
 
-<a name="android"></a>
 ### Android
 
 * Go to the directory `script/android` and run the file `install_packages.bat` if your development platform is Windows or
   `install_packages.sh` if your development platform is macOS or Linux. This script will install all the required packages
   to build the project using Android Studio.
 * Launch Android Studio, open the project in the `android` directory and run the build.
 
-<a name="playstation-vita"></a>
 ### PlayStation Vita
 
 If you would like to build and run this project on PlayStation Vita please follow the instructions on [**this page**](README_PSV.md).
 
-<a name="nintendo-switch"></a>
 ### Nintendo Switch
 
 If you would like to build and run this project on Nintendo Switch please follow the instructions on [**this page**](README_switch.md).
 
-<a name="build-with-cmake"></a>
 ### Build with CMake
 
 If you would like to build the project using CMake please follow the instructions on [**this page**](README_cmake.md).

docs/GRAPHICAL_ASSETS.md

@@ -12,35 +12,35 @@ This guide is designed for Linux, MacOS and Windows users. The source files to t
 
 ## Where to get the tools
 
-You can download the precompiled tools for your operating system (OS) of choice here:<br>
-[Windows 32-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-windows-x86-SDL2/fheroes2_tools_windows_x86_SDL2.zip)<br>
+You can download the precompiled tools for your operating system (OS) of choice here:  
+[Windows 32-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-windows-x86-SDL2/fheroes2_tools_windows_x86_SDL2.zip)  
 [Windows 64-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-windows-x64-SDL2/fheroes2_tools_windows_x64_SDL2.zip)
 
 [MacOS](https://github.com/ihhub/fheroes2/releases/download/fheroes2-osx-sdl2_dev/fheroes2_tools_macos_x86-64_SDL2.zip)
 
-[Linux Ubuntu 64-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-linux-sdl2_dev/fheroes2_tools_ubuntu_x86-64_SDL2.zip)<br>
+[Linux Ubuntu 64-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-linux-sdl2_dev/fheroes2_tools_ubuntu_x86-64_SDL2.zip)  
 [Linux Ubuntu ARM 64-bit](https://github.com/ihhub/fheroes2/releases/download/fheroes2-linux-arm-sdl2_dev/fheroes2_tools_ubuntu_arm64_SDL2.zip)
 
-
 Here is a list and short description of the various graphical artist tools:
 
-- extractor
+* extractor
 
 This tool extracts all the contents of the AGG files mentioned above. Among the extracted files are the ICNs which hold the graphical assets.
 
-- icn2img
+* icn2img
 
 This tool converts the various graphical assets contained within the ICNs into PNG or BMP files.
 
-- pal2img
+* pal2img
 
 This tool generates a PNG or BMP file from the palette file `KB.PAL`. It displays it as 16x16 tiles of 16 pixels each.
 Some colors in the game are used for the cycling animation. They are marked in the generated image by a black area in
 the top-left corner on a tile. Use these colors only if the animation is a requirement:
-- 214, 215, 216, 217
-- 218, 219, 220, 221
-- 231, 232, 233, 234, 235
-- 238, 239, 240, 241
+
+* 214, 215, 216, 217
+* 218, 219, 220, 221
+* 231, 232, 233, 234, 235
+* 238, 239, 240, 241
 
 ## How to use the tools to extract the images