Add CI for checking markdown format. (#1662)

Signed-off-by: ChenYing Kuo <[email protected]>
eclipse-zenoh · Dec 12, 2024 · 8716c87 · 8716c87
1 parent b7381b5
commit 8716c87
Show file tree

Hide file tree

Showing 37 changed files with 30 additions and 74 deletions.
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -186,6 +186,16 @@ jobs:
 
       - name: Check spelling
         uses: crate-ci/typos@master
+
+  markdown_lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: articulate/actions-markdownlint@v1
+        with:
+          config: .markdownlint.yaml
+          files: '*.md'
+          ignore: target
+          version: 0.28.1
 
   # NOTE: In GitHub repository settings, the "Require status checks to pass
   # before merging" branch protection rule ensures that commits are only merged

diff --git a/.markdownlint.yaml b/.markdownlint.yaml
@@ -0,0 +1,6 @@
+{
+  "MD013": false, # Line length limitation
+  "MD033": false, # Enable Inline HTML
+  "MD041": false, # Allow first line heading
+  "MD045": false, # Allow Images have no alternate text
+}
diff --git a/commons/zenoh-buffers/README.md b/commons/zenoh-buffers/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-codec/README.md b/commons/zenoh-codec/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-collections/README.md b/commons/zenoh-collections/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-config/README.md b/commons/zenoh-config/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-core/README.md b/commons/zenoh-core/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-crypto/README.md b/commons/zenoh-crypto/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-keyexpr/README.md b/commons/zenoh-keyexpr/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-macros/README.md b/commons/zenoh-macros/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-protocol/README.md b/commons/zenoh-protocol/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-result/README.md b/commons/zenoh-result/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-runtime/README.md b/commons/zenoh-runtime/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-shm/README.md b/commons/zenoh-shm/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-sync/README.md b/commons/zenoh-sync/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-task/README.md b/commons/zenoh-task/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/commons/zenoh-util/README.md b/commons/zenoh-util/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-link-commons/README.md b/io/zenoh-link-commons/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-link/README.md b/io/zenoh-link/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/README.md b/io/zenoh-links/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-quic/README.md b/io/zenoh-links/zenoh-link-quic/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-serial/README.md b/io/zenoh-links/zenoh-link-serial/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-tcp/README.md b/io/zenoh-links/zenoh-link-tcp/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-tls/README.md b/io/zenoh-links/zenoh-link-tls/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-udp/README.md b/io/zenoh-links/zenoh-link-udp/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-unixpipe/README.md b/io/zenoh-links/zenoh-link-unixpipe/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-unixsock_stream/README.md b/io/zenoh-links/zenoh-link-unixsock_stream/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-vsock/README.md b/io/zenoh-links/zenoh-link-vsock/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-links/zenoh-link-ws/README.md b/io/zenoh-links/zenoh-link-ws/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/io/zenoh-transport/README.md b/io/zenoh-transport/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/plugins/zenoh-backend-traits/README.md b/plugins/zenoh-backend-traits/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/plugins/zenoh-plugin-example/README.md b/plugins/zenoh-plugin-example/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/plugins/zenoh-plugin-rest/README.md b/plugins/zenoh-plugin-rest/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/plugins/zenoh-plugin-storage-manager/README.md b/plugins/zenoh-plugin-storage-manager/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/plugins/zenoh-plugin-trait/README.md b/plugins/zenoh-plugin-trait/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/zenoh-ext/README.md b/zenoh-ext/README.md
@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.
 
 - [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
 - [Click here for Zenoh's documentation](https://zenoh.io)
-
-
diff --git a/zenoh-ext/examples/examples/README.md b/zenoh-ext/examples/examples/README.md
@@ -3,6 +3,7 @@
 ## Start instructions
 
    When zenoh is built in release mode:
+
    ```bash
    ./target/release/example/<example_name>
    ```
@@ -22,12 +23,15 @@
    or retransmission.
 
    Typical usage:
+
    ```bash
-      z_advanced_pub
+   z_advanced_pub
    ```
+
    or
+
    ```bash
-      z_advanced_pub --history 10
+   z_advanced_pub --history 10
    ```
 
 ### z_advanced_sub
@@ -38,27 +42,31 @@
    sample loss and ask for retransmission.
 
    Typical usage:
+
    ```bash
-      z_advanced_sub
+   z_advanced_sub
    ```
 
 ### z_member
 
    Group Management example: join a group and display the received group events (Join, Leave, LeaseExpired), as well as an updated group view.
 
    Typical usage:
+
    ```bash
-      z_member
+   z_member
    ```
+
    (start/stop several in parallel)
 
 ### z_view_size
 
    Group Management example: join a group and wait for the group view to reach a configurable size (default: 3 members).
 
    Typical usage:
+
    ```bash
-      z_view_size
+   z_view_size
    ```
-   (start/stop several in parallel)
 
+   (start/stop several in parallel)
Original file line number	Diff line number	Diff line change
Expand Up		@@ -4,5 +4,3 @@ This crate is intended for Zenoh's internal use.

		- [Click here for Zenoh's main repository](https://github.com/eclipse-zenoh/zenoh)
		- [Click here for Zenoh's documentation](https://zenoh.io)