add markdownlint

miaucl · Aug 22, 2024 · 2560900 · 2560900
1 parent 75f8647
commit 2560900
Show file tree

Hide file tree

Showing 6 changed files with 32 additions and 2 deletions.
diff --git a/.github/workflows/markdownlint.yml b/.github/workflows/markdownlint.yml
@@ -0,0 +1,19 @@
+name: Markdownlint
+
+on: [ push, pull_request ]
+
+jobs:
+  markdownlint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: DavidAnson/markdownlint-cli2-action@v16
+        with:
+          config: '.markdownlint.yaml'
+          globs: |
+            README.md
+            CHANGELOG.md
+            docs/*.md
+            !docs/changelog.md
+            !docs/index.md
+            !docs/license.md
diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,5 @@
+# Default state for all rules
+default: true
+
+# MD013/line-length - Line length
+MD013: false
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -0,0 +1,5 @@
+# CHANGELOG
+
+## 2.0.0
+
+* Rework of the complete structure, but no functional changes.
diff --git a/README.md b/README.md
@@ -98,7 +98,7 @@ Data is also published to the topic `docker/<DOCKER2MQTT_HOSTNAME>/<container>/s
 
 After you start the service binary sensors should show up in Home Assistant immediately. Look for sensors that start with `binary_sensor.docker`. Metadata about the container will be available as attributes, which you can then expose using template sensors if you wish.
 
-![Screenshot of Home Assistant sensor showing status and attributes.](ha_screenshot.png)
+![Screenshot of Home Assistant sensor showing status and attributes.](docs/ha_screenshot.png)
 
 ## Dev
 
@@ -123,6 +123,7 @@ Following VSCode integrations may be helpful:
 
 * [ruff](https://marketplace.visualstudio.com/items?itemName=charliermarsh.ruff)
 * [mypy](https://marketplace.visualstudio.com/items?itemName=matangover.mypy)
+* [markdownlint](https://marketplace.visualstudio.com/items?itemName=DavidAnson.vscode-markdownlint)
 
 ## Credits
 

diff --git a/ha_screenshot.png → docs/ha_screenshot.png b/ha_screenshot.png → docs/ha_screenshot.png
diff --git a/setup.cfg b/setup.cfg
@@ -4,7 +4,7 @@ version = 2.0.0-rc.0
 author = Cyrill Raccaud
 author_email = [email protected]
 description = Send your docker stats and and events to mqtt and discovery them in home assistant.
-long_description = file: README.md, LICENCE
+long_description = file: README.md, CHANGELOG.md, LICENCE
 long_description_content_type = text/markdown
 license_files = LICENSE
 url = https://github.com/miaucl/docker2mqtt