Reformat code style

.editorconfig

@@ -12,3 +12,6 @@ trim_trailing_whitespace = true
 
 [{*.markdown,*.md}]
 trim_trailing_whitespace = false
+
+[docs/**/*.md]
+ij_formatter_enabled = false

.github/ISSUE_TEMPLATE/bug_report.yml

@@ -1,6 +1,6 @@
 name: Bug Report
 description: File a bug report to help us improve the project.
-labels: ["bug"]
+labels: ['bug']
 body:
   - type: markdown
     attributes:
@@ -49,9 +49,9 @@ body:
       label: Environment
       description: What environment were you using when you encountered the bug?
       options:
-        - "Web Browser (specify name and version)"
+        - 'Web Browser (specify name and version)'
-        - "Mobile Application (specify OS and version)"
+        - 'Mobile Application (specify OS and version)'
-        - "Other (please specify, including version)"
+        - 'Other (please specify, including version)'
     validations:
       required: true
 

.github/ISSUE_TEMPLATE/feature_request.yml

@@ -1,6 +1,6 @@
 name: Feature Request
 description: Suggest a new feature or improvement for the project.
-labels: ["enhancement"]
+labels: ['enhancement']
 body:
   - type: markdown
     attributes:

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,4 +1,4 @@
-Please click the `Preview` tab and select the type of Pull Request you are submitting.
+# Please click the `Preview` tab and select the type of Pull Request you are submitting
 
 - [Bug Fix](?expand=1&template=bugfix.md)
 - [Feature](?expand=1&template=feature.md)
@@ -9,5 +9,7 @@ Please click the `Preview` tab and select the type of Pull Request you are submi
 >
 > - [Translation Contribution](?expand=1&template=translation.md)
 
+---
+
 > [!CAUTION]
 > Any Pull Request that does not follow the above types will be rejected.

.github/dependabot.yml

@@ -2,25 +2,25 @@
 
 version: 2
 updates:
-  - package-ecosystem: "npm"
+  - package-ecosystem: 'npm'
-    directory: "/"
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     groups:
       dependencies:
-        patterns: ["*"] 
+        patterns: ['*']
     labels:
-      - "dependencies"
+      - 'dependencies'
     pull-request-branch-name:
-      separator: "-"
+      separator: '-'
-  - package-ecosystem: "github-actions"
+  - package-ecosystem: 'github-actions'
-    directory: "/"
+    directory: '/'
     schedule:
-      interval: "weekly"
+      interval: 'weekly'
     groups:
       actions:
-        patterns: ["*"] 
+        patterns: ['*']
     labels:
-      - "actions"
+      - 'actions'
     pull-request-branch-name:
-      separator: "-"
+      separator: '-'

.github/workflows/validate.yml

@@ -6,9 +6,9 @@ on:
 jobs:
   hacs:
     name: HACS Action
-    runs-on: "ubuntu-latest"
+    runs-on: 'ubuntu-latest'
     steps:
       - name: HACS Action
-        uses: "hacs/action@22.5.0"
+        uses: 'hacs/action@22.5.0'
         with:
-          category: "plugin"
+          category: 'plugin'

.markdownlint.jsonc

@@ -0,0 +1,22 @@
+{
+  "$schema": "https://raw.githubusercontent.com/DavidAnson/markdownlint/main/schema.json",
+  "default": true,
+  "MD013": {
+    "line_length": 120,
+    "code_block_line_length": 120,
+    "heading_line_length": 80,
+    "tables": false
+  },
+  "MD024": {
+    "siblings_only": true
+  },
+  "MD033": {
+    "allowed_elements": [
+      "br",
+      "summary",
+      "details"
+    ]
+  },
+  "MD040": false,
+  "MD046": false
+}

docs/full-example.md

@@ -1,4 +1,4 @@
-Here is a full example using all the options provided with the strategy.
+# Full example using all the options provided with the strategy
 
 ```yaml
 strategy:

docs/index.md

@@ -1,4 +1,4 @@
-# Welcome to the Mushroom Strategy Documentation :material-mushroom:
+# Welcome to the Mushroom Strategy Documentation :material-mushroom:  
 
 [![Release][releaseBadge]][releaseUrl]
 [![HACS][hacsBadge]][hacsUrl]
@@ -51,8 +51,7 @@ engage with the community!
 **Enjoying the Mushroom Strategy?** Consider giving our project a
 :star: [star on GitHub](https://github.com/DigiLive/mushroom-strategy) and exploring ways
 to :heart: [sponsor the project](https://github.com/sponsors/DigiLive) to support its continued development! Your
-support
+support helps us grow and improve.
-helps us grow and improve.
 
 ## Previews
 
@@ -71,8 +70,6 @@ helps us grow and improve.
 
 [releaseBadge]: https://img.shields.io/github/v/tag/digilive/mushroom-strategy?filter=v2.3.2&label=Release
 
-[sponsorBadge]: https://img.shields.io/badge/Sponsor_him-%E2%9D%A4-%23db61a2.svg?&logo=github&color=%23fe8e86
-
 <!-- Repository References -->
 
 [releaseUrl]: https://github.com/DigiLive/mushroom-strategy/releases/tag/v2.3.2

docs/options/domain-options.md

@@ -31,7 +31,7 @@ Use `_` as the identifier to set options for all domains.
 
 ## Example
 
-```YAML
+```yaml
 strategy:
   type: custom:mushroom-strategy
   options:

mkdocs.yml

@@ -58,7 +58,7 @@ nav:
 
 markdown_extensions:
   - toc:
-      permalink: "#"
+      permalink: '#'
   - admonition
   - pymdownx.superfences
   - pymdownx.details

package.json

@@ -36,6 +36,7 @@
     "eslint-config-prettier": "^10.1.5",
     "eslint-plugin-prettier": "^5.4.0",
     "home-assistant-js-websocket": "^9.5.0",
+    "markdownlint-cli2": "^0.18.1",
     "prettier": "^3.5.3",
     "superstruct": "^2.0.2",
     "ts-loader": "^9.5.2",
@@ -46,6 +47,9 @@
     "webpack-cli": "^6.0.1"
   },
   "scripts": {
+    "mkdocs:serve": "mkdocs serve",
+    "lint:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\"",
+    "fix:md": "markdownlint-cli2 \"**/*.md\" \"#node_modules\" \"#dist\" \"#build\" --fix",
     "build-dev": "webpack --config webpack.dev.config.ts",
     "build": "webpack",
     "bump": "bump --preid alpha package.json package-lock.json README.md ./src/mushroom-strategy.ts"

src/types/homeassistant/README.md

@@ -1,3 +1,5 @@
+# Notice
+
 This directory contains partial code from
 the [Home Assistant Frontend repository](https://github.com/home-assistant/frontend).
 

src/types/lovelace-mushroom/README.md

@@ -1,3 +1,5 @@
+# Notice
+
 This directory contains partial code from
 the [Lovelace Mushroom repository](https://github.com/piitaya/lovelace-mushroom).