chore: markdownlint

.github/workflows/lint.yml

@@ -0,0 +1,23 @@
+name: lint
+on:
+    pull_request:
+
+jobs:
+  markdown-lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node
+        uses: actions/setup-node@v4
+        with:
+          node-version: 18
+
+      - name: Install markdownlint-cli
+        run: npm install -g [email protected]
+        shell: bash
+
+      - name: Run markdownlint
+        run: markdownlint --config .markdownlint.yaml **/*.md
+        shell: bash

.markdownlint.yaml

@@ -0,0 +1,5 @@
+"default": true # Default state for all rules
+"MD010":
+  "code_blocks": false # Disable rule for hard tabs in code blocks
+"MD013": false # Disable rule for line length
+"MD033": false # Disable rule banning inline HTML

README.md

@@ -13,7 +13,6 @@ Read [CIP-1](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-1.md) for in
 | 2 | December 13, 2023 | [Agenda](https://github.com/celestiaorg/CIPs/issues/22) | [Tweet Thread](https://x.com/JoshCStein/status/1734967567075168697) | [Recording](https://www.youtube.com/watch?v=yYt600kvf4g) |
 | 1 | November 29, 2023 | [Agenda](https://github.com/celestiaorg/CIPs/issues/8)  | [Tweet Thread](https://x.com/JoshCStein/status/1729893879191621702) | [Recording](https://www.youtube.com/watch?v=EhWHHmPo_5Q) |
 
-
 ## Celestia Improvement Proposals (CIPs)
 
 |  №  |      Title       | Author(s) |
@@ -29,11 +28,18 @@ Read [CIP-1](https://github.com/celestiaorg/CIPs/blob/main/cips/cip-1.md) for in
 | [9](/cips/cip-9.md) | Packet Forward Middleware | Alex Cheng (@akc2267) |
 | [10](/cips/cip-10.md) | Coordinated network upgrades | Callum Waters (@cmwaters) |
 | [11](/cips/cip-11.md) | Refund unspent gas | Rootul Patel (@rootulp) |
-| [12](/cips/cip-12.md) | ICS-29 Relayer Incentivisation Middleware | Susannah Evans [email protected] @womensrights, Aditya Sripal [email protected] @AdityaSripal |
+| [12](/cips/cip-12.md) | ICS-29 Relayer Incentivisation Middleware | Susannah Evans <[email protected]> @womensrights, Aditya Sripal <[email protected]> @AdityaSripal |
 | [13](/cips/cip-13.md) | On-chain Governance Parameters for Celestia Network | Yaz Khoury <[email protected]>,  Evan Forbes <[email protected]> |
 | [14](/cips/cip-14.md) | ICS-27 Interchain Accounts | Susannah Evans <[email protected]> (@womensrights), Aidan Salzmann <[email protected]> (@asalzmann), Sam Pochyly <[email protected]> (@sampocs) |
 | [15](/cips/cip-15.md) | Discourage memo usage | Rootul Patel (@rootulp), NashQueue (@nashqueue) |
 | [16](/cips/cip-16.md) | Make Security Related Governance Parameters Immutable | Mingpei CAO (@caomingpei) |
 | [17](/cips/cip-17.md) | Lemongrass Hardfork | Evan Forbes (@evan-forbes) |
 | [18](/cips/cip-18.md) | Standardised Gas and Pricing Estimation Interface | Callum Waters (@cmwaters) |
 
+## Contributing
+
+Files in this repo must conform to [markdownlint](https://github.com/DavidAnson/markdownlint). Install [markdownlint](https://github.com/DavidAnson/markdownlint) and then run:
+
+```shell
+markdownlint --config .markdownlint.yaml '**/*.md'
+```