chore: optimize markdownlint and stylelint config and handle issues

Author: KristjanESPERANTO

.markdownlint.json

@@ -1,4 +1,5 @@
 {
   "line_length": false,
+  "no-duplicate-heading": false,
   "no-inline-html": false
 }

guides/readme_bestpractices.md

@@ -1,21 +1,23 @@
-This file contains suggested best practices for creating a README file for your MagicMirror² module.  
+# Best Practices for README Files
 
-# Installation Instructions
+This file contains suggested best practices for creating a README file for your MagicMirror² module.
+
+## Installation Instructions
 
 Your README file should have an "Installation" section that includes a code block that can be pasted into a user's terminal to fully install your module. Here is a good example of an install code block:
 
-## Example if your module has no dependencies
+### Example if your module has no dependencies
 
-````
+````markdown
 ```bash
 cd ~/MagicMirror/modules
 git clone https://github.com/MyUsername/MMM-MyModule
 ```
 ````
 
-## Example if your module has dependencies
+### Example if your module has dependencies
 
-````
+````markdown
 ```bash
 cd ~/MagicMirror/modules
 git clone https://github.com/MyUsername/MMM-MyModule
@@ -24,22 +26,22 @@ npm ci --omit=dev
 ```
 ````
 
-## Tips
+### Tips
 
-* The code block should not be broken up into multiple separate blocks for each line of code so that users can copy and paste the entire block into their terminal and execute the install with one click.
-* The opening `` ``` `` of your code block should be followed by "`sh`" or "`bash`" so that the code block is styled as shell script.
-* If your module has required dependencies, `npm ci` is preferable to `npm install` in many circumstances because it will repeatably instruct users' machines not to recreate the `package-lock.json` file.
-* Adding `--omit=dev` to the `npm ci` or `npm install` command will instruct users' machines not to install developer dependencies that are unneeded by most users, which will save on install time and disk space.
+- The code block should not be broken up into multiple separate blocks for each line of code so that users can copy and paste the entire block into their terminal and execute the install with one click.
+- The opening ` ``` ` of your code block should be followed by "`sh`" or "`bash`" so that the code block is styled as shell script.
+- If your module has required dependencies, `npm ci` is preferable to `npm install` in many circumstances because it will repeatably instruct users' machines not to recreate the `package-lock.json` file.
+- Adding `--omit=dev` to the `npm ci` or `npm install` command will instruct users' machines not to install developer dependencies that are unneeded by most users, which will save on install time and disk space.
 
-# Update Instructions
+## Update Instructions
 
 Your README file should have an "Update" section that includes a code block that can be pasted into a user's terminal to update your module.
 
-# Config Instructions
+## Config Instructions
 
-Your README file should have a "Config" or "Configuration" section that includes an example config block that can be pasted into user's `config.js` files.  Here is a good example of a config code block:
+Your README file should have a "Config" or "Configuration" section that includes an example config block that can be pasted into user's `config.js` files. Here is a good example of a config code block:
 
-````
+````markdown
 ```js
 {
   module: MMM-MyModule,
@@ -52,8 +54,8 @@ Your README file should have a "Config" or "Configuration" section that includes
 ```
 ````
 
-## Tips
+### Tips
 
-* The opening `` ``` `` of your code block should be followed by "`js`" or "`javascript`" so that the code block is styled as javasript.
-* The final `}` should be followed by a `,` so that the block can be copied and pasted straight into users' `config.js` files without throwing errors.
-* The example config should provide a minimal demo configuration that will get your module working if pasted directly into a user's `config.js` file.
+- The opening ` ``` ` of your code block should be followed by "`js`" or "`javascript`" so that the code block is styled as JavaScript.
+- The final `}` should be followed by a `,` so that the block can be copied and pasted straight into users' `config.js` files without throwing errors.
+- The example config should provide a minimal demo configuration that will get your module working if pasted directly into a user's `config.js` file.

package.json

@@ -34,8 +34,8 @@
     "checkModulesJs": "node scripts/check_modules_js.js",
     "checkModules": "python3 scripts/check_modules.py",
     "ownList": "node create_own_module_list.js && npm run updateGitHubData && npm run getModules && npm run expandModuleList && npm run checkModulesJs && npm run checkModules",
-    "lint": "eslint && stylelint **/docs/*.css && markdownlint-cli2 README.md && prettier --check . && cspell .",
-    "lint:fix": "eslint --fix && stylelint **/docs/*.css --fix && markdownlint-cli2 README.md --fix && prettier . --write . && cspell .",
+    "lint": "eslint && stylelint **/docs/*.css && markdownlint-cli2 . && prettier --check . && cspell .",
+    "lint:fix": "eslint --fix && stylelint **/docs/*.css --fix && markdownlint-cli2 . --fix && prettier . --write . && cspell .",
     "prepare": "husky",
     "test": "npm run lint",
     "leaveMenu": "",
@@ -47,11 +47,11 @@
       "prettier --write --ignore-unknown"
     ],
     "*.css": [
-      "stylelint **/docs/*.css --ignore-pattern **/docs/fonts/ --fix",
+      "stylelint --ignore-pattern **/docs/fonts/ --fix",
       "prettier --write"
     ],
     "*.md": [
-      "markdownlint --ignore node_modules --fix",
+      "markdownlint-cli2 --fix",
       "prettier --write"
     ]
   },